#Kitchen Sink

Use this page to preview the common Markdown and notice styles supported by the docs renderer.

#Headings

#Level 3 Heading

#Level 4 Heading

#Paragraphs & Links

Use bold text, italic text, and inline code for short callouts in prose.

Inline syntax highlighting works too: pnpm dev or console.log("curl.md").

Link to Installation for setup instructions, or visit GitHub for source code.

#Lists

Unordered lists work for short collections.
Nested items are supported.
- This is a nested bullet.
- This is another nested bullet.
Keep bullets short when possible.

Ordered lists work well for step-by-step instructions.
They keep sequence obvious.
They also match the rest of the docs UI.

#Blockquotes

Regular blockquotes still render as blockquotes.

Use them for quotes that are not notices.

#Horizontal Rule

The separator above is a standard horizontal rule.

#Code Blocks

$curl.md https://example.com

{
  "runtime": "node",
  "watch": true
}

example.ts

import { create } from 'curl.md'
import { rules } from 'curl.md'

const md = create({ rules: [rules.githubRepo()] })

#Code Groups

$npm run dev

$npm install

#Details

Show extra guidance

Native disclosure elements work in docs pages too.

Use them for optional context.
Keep the summary short and scannable.

#Notices

Note

Notices without a custom title default to the notice type.

Custom tip title

Use titled notices when the label should be more specific than the default notice type.

Hint

Hints work well for shortcuts, alternatives, or small workflow improvements.

Important

Use important notices for behavior people should not miss.

Warning

Warnings should call out risky behavior or easy-to-make mistakes.

Danger

Danger notices are useful when a step can be destructive or hard to undo.

Tip

Tips still use the same shared notice component without relying on GitHub alert syntax.

#Tables

Runtime	Install Command	Config File	Best For
Node.js	`pnpm add curl.md`	`curl.config.ts`	Existing TypeScript apps
Bun	`bun add curl.md`	`bunfig.toml`	Fast local tooling
Deno	`deno add jsr:@wevm/curl-md`	`deno.json`	URL-first workflows
CI	`pnpm dlx curl.md https://example.com/rules.md`	`.github/workflows/docs.yml`	One-off checks in pipelines

#Steps

1
Install dependencies
Use your preferred package manager to install project dependencies.
2
Start the dev server
$pnpm dev
3
Open the app
Visit https://curl.local once the server is running.

#Cards

Install curl.md

Start with the CLI for terminal and script usage.

Amp plugin

Enable docs fetch interception inside Amp.

Authentication

Set up auth for higher rate limits and account features.

#Package Links

curl.md Source code

Edit page

Last updated: May 5 3:02 PM

#Kitchen SinkCopy page