Skip to content

Commit ad2fabd

Browse files
larbishlarbish
authored
fix(docs): wrong anchor links (#182)
1 parent 56212bb commit ad2fabd

13 files changed

Lines changed: 85 additions & 85 deletions

File tree

‎docs/content/3.rendering/2.html.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ This is a **bold** statement with a [link](https://example.com).
7777

7878
| Option | Type | Default | Description |
7979
| --- | --- | --- | --- |
80-
| [`plugins`](#code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
81-
| [`components`](#code-components) | `Record<string, fn>` | `{}` | Custom component renderers |
82-
| [`data`](#code-data) | `Record<string, any>` | `undefined` | Data passed to component renderers |
80+
| [`plugins`](#code-render-options-code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
81+
| [`components`](#code-render-options-code-components) | `Record<string, fn>` | `{}` | Custom component renderers |
82+
| [`data`](#code-render-options-code-data) | `Record<string, any>` | `undefined` | Data passed to component renderers |
8383

8484
#### `plugins`
8585

@@ -179,7 +179,7 @@ const html2 = await render('# Document 2\n\n...')
179179

180180
#### Options
181181

182-
Same as [`render()`](#options).
182+
Same as [`render()`](#code-render-options).
183183

184184
---
185185

@@ -218,8 +218,8 @@ const html = await renderHTML(tree)
218218

219219
| Option | Type | Description |
220220
| --- | --- | --- |
221-
| [`components`](#code-components) | `Record<string, fn>` | Custom component renderers |
222-
| [`data`](#code-data) | `Record<string, any>` | Data passed to component renderers |
221+
| [`components`](#code-render-options-code-components) | `Record<string, fn>` | Custom component renderers |
222+
| [`data`](#code-render-options-code-data) | `Record<string, any>` | Data passed to component renderers |
223223

224224
---
225225

‎docs/content/3.rendering/3.vue.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,14 @@ Pass markdown content via the default slot or the `markdown` prop:
9595
| Prop | Type | Default | Description |
9696
|------|------|---------|-------------|
9797
| `markdown` | `string` | `undefined` | Alternative to default slot |
98-
| [`options`](#code-options) | `ParseOptions` | `{}` | Parser options (autoUnwrap, autoClose, etc.) |
99-
| [`plugins`](#code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
100-
| [`components`](#code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
101-
| [`componentsManifest`](#code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver |
98+
| [`options`](#code-comark-props-code-options) | `ParseOptions` | `{}` | Parser options (autoUnwrap, autoClose, etc.) |
99+
| [`plugins`](#code-comark-props-code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
100+
| [`components`](#code-comark-props-code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
101+
| [`componentsManifest`](#code-comark-props-code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver |
102102
| [`streaming`](#streaming) | `boolean` | `false` | Enable streaming mode |
103103
| `summary` | `boolean` | `false` | Only render content before `<!-- more -->` |
104-
| [`caret`](#caret) | `boolean \| { class: string }` | `false` | Append caret to last text node |
105-
| [`data`](#code-data) | `Record<string, unknown>` | `{}` | Runtime values referenced from markdown via `:prop="data.path"` |
104+
| [`caret`](#streaming-caret) | `boolean \| { class: string }` | `false` | Append caret to last text node |
105+
| [`data`](#code-comark-props-code-data) | `Record<string, unknown>` | `{}` | Runtime values referenced from markdown via `:prop="data.path"` |
106106

107107
#### `options`
108108

@@ -328,13 +328,13 @@ import { AppComark } from './comark'
328328

329329
| Option | Type | Default | Description |
330330
|--------|------|---------|-------------|
331-
| [`extends`](#extends) | `ReturnType<typeof defineComarkComponent>` | `undefined` | Inherit plugins and components from another component |
331+
| [`extends`](#code-comark-code-definecomarkcomponent-code-extends) | `ReturnType<typeof defineComarkComponent>` | `undefined` | Inherit plugins and components from another component |
332332
| `name` | `string` | `undefined` | Component name for debugging |
333333
| `autoUnwrap` | `boolean` | `true` | Automatically unwrap single block elements |
334334
| `autoClose` | `boolean` | `true` | Auto-close incomplete markdown syntax |
335335
| `html` | `boolean` | `true` | Parse embedded HTML tags into AST nodes |
336-
| [`plugins`](#code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
337-
| [`components`](#code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
336+
| [`plugins`](#code-comark-props-code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
337+
| [`components`](#code-comark-props-code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
338338
| `class` | `string` | `undefined` | Additional CSS classes for the wrapper div |
339339

340340
#### `extends`
@@ -430,11 +430,11 @@ const tree = await res.json()
430430
| Prop | Type | Default | Description |
431431
|------|------|---------|-------------|
432432
| `tree` | `ComarkTree` | — | **Required.** The parsed tree returned by `parse()` |
433-
| [`components`](#code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
434-
| [`componentsManifest`](#code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver for lazy-loaded components |
433+
| [`components`](#code-comark-props-code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
434+
| [`componentsManifest`](#code-comark-props-code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver for lazy-loaded components |
435435
| [`streaming`](#streaming) | `boolean` | `false` | Enable streaming mode |
436-
| [`caret`](#caret) | `boolean \| { class: string }` | `false` | Append a blinking caret to the last text node |
437-
| [`data`](#code-data) | `Record<string, unknown>` | `{}` | Runtime values referenced from markdown via `:prop="data.path"` |
436+
| [`caret`](#streaming-caret) | `boolean \| { class: string }` | `false` | Append a blinking caret to the last text node |
437+
| [`data`](#code-comark-props-code-data) | `Record<string, unknown>` | `{}` | Runtime values referenced from markdown via `:prop="data.path"` |
438438

439439
### `defineComarkRendererComponent`
440440

@@ -483,9 +483,9 @@ const tree = await res.json()
483483

484484
| Option | Type | Default | Description |
485485
|--------|------|---------|-------------|
486-
| [`extends`](#inheritance) | `ReturnType<typeof defineComarkRendererComponent>` | `undefined` | Inherit component mappings from another renderer |
486+
| [`extends`](#code-comarkrenderer-code-definecomarkrenderercomponent-inheritance) | `ReturnType<typeof defineComarkRendererComponent>` | `undefined` | Inherit component mappings from another renderer |
487487
| `name` | `string` | `undefined` | Component name for debugging |
488-
| [`components`](#code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
488+
| [`components`](#code-comark-props-code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
489489
| `class` | `string` | `undefined` | Additional CSS classes for the wrapper div |
490490

491491
#### Inheritance

‎docs/content/3.rendering/4.nuxt.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ Pass markdown via the default slot or the `markdown` prop:
8383
| Prop | Type | Default | Description |
8484
|------|------|---------|-------------|
8585
| `markdown` | `string` | `undefined` | Alternative to default slot |
86-
| [`options`](#code-options) | `ParseOptions` | `{}` | Parser options (autoUnwrap, autoClose, etc.) |
87-
| [`plugins`](#code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
88-
| [`components`](#code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
89-
| [`componentsManifest`](#code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver |
86+
| [`options`](#code-comark-props-code-options) | `ParseOptions` | `{}` | Parser options (autoUnwrap, autoClose, etc.) |
87+
| [`plugins`](#code-comark-props-code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
88+
| [`components`](#code-comark-props-code-components) | `Record<string, Component>` | `{}` | Custom Vue component mappings |
89+
| [`componentsManifest`](#code-comark-props-code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver |
9090
| [`streaming`](#streaming) | `boolean` | `false` | Enable streaming mode |
9191
| `summary` | `boolean` | `false` | Only render content before `<!-- more -->` |
92-
| [`caret`](#caret) | `boolean \| { class: string }` | `false` | Append caret to last text node |
92+
| [`caret`](#streaming-caret) | `boolean \| { class: string }` | `false` | Append caret to last text node |
9393

9494
#### `options`
9595

‎docs/content/3.rendering/5.react.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,13 @@ Pass markdown content via `children` or the `markdown` prop:
8484
|------|------|---------|-------------|
8585
| `children` | `React.ReactNode` | - | Markdown content to parse and render |
8686
| `markdown` | `string` | `''` | Alternative to children |
87-
| [`options`](#code-options) | `ParseOptions` | `{}` | Parser options (autoUnwrap, autoClose, etc.) |
88-
| [`plugins`](#code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
89-
| [`components`](#code-components) | `Record<string, ComponentType>` | `{}` | Custom React component mappings |
90-
| [`componentsManifest`](#code-componentsmanifest) | `(name: string) => Promise<Component>` | `undefined` | Dynamic component resolver |
87+
| [`options`](#code-comark-props-code-options) | `ParseOptions` | `{}` | Parser options (autoUnwrap, autoClose, etc.) |
88+
| [`plugins`](#code-comark-props-code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
89+
| [`components`](#code-comark-props-code-components) | `Record<string, ComponentType>` | `{}` | Custom React component mappings |
90+
| [`componentsManifest`](#code-comark-props-code-componentsmanifest) | `(name: string) => Promise<Component>` | `undefined` | Dynamic component resolver |
9191
| [`streaming`](#streaming) | `boolean` | `false` | Enable streaming mode |
92-
| [`caret`](#caret) | `boolean \| { class: string }` | `false` | Append caret to last text node |
93-
| [`data`](#code-data) | `Record<string, unknown>` | `undefined` | Runtime values referenced from markdown via `:prop="data.path"` |
92+
| [`caret`](#streaming-caret) | `boolean \| { class: string }` | `false` | Append caret to last text node |
93+
| [`data`](#code-comark-props-code-data) | `Record<string, unknown>` | `undefined` | Runtime values referenced from markdown via `:prop="data.path"` |
9494
| `className` | `string` | `undefined` | CSS class for wrapper element |
9595

9696
#### `options`
@@ -291,13 +291,13 @@ export default function App() {
291291

292292
| Option | Type | Default | Description |
293293
|--------|------|---------|-------------|
294-
| [`extends`](#extends) | `ReturnType<typeof defineComarkComponent>` | `undefined` | Inherit plugins and components from another component |
294+
| [`extends`](#code-comark-code-definecomarkcomponent-code-extends) | `ReturnType<typeof defineComarkComponent>` | `undefined` | Inherit plugins and components from another component |
295295
| `name` | `string` | `undefined` | Component name for debugging |
296296
| `autoUnwrap` | `boolean` | `true` | Automatically unwrap single block elements |
297297
| `autoClose` | `boolean` | `true` | Auto-close incomplete markdown syntax |
298298
| `html` | `boolean` | `true` | Parse embedded HTML tags into AST nodes |
299-
| [`plugins`](#code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
300-
| [`components`](#code-components) | `Record<string, ComponentType>` | `{}` | Custom React component mappings |
299+
| [`plugins`](#code-comark-props-code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
300+
| [`components`](#code-comark-props-code-components) | `Record<string, ComponentType>` | `{}` | Custom React component mappings |
301301
| `className` | `string` | `undefined` | Additional CSS classes for the wrapper div |
302302

303303
#### `extends`
@@ -398,11 +398,11 @@ export default async function DocsPage({ params }: { params: { slug: string } })
398398
| Prop | Type | Default | Description |
399399
|------|------|---------|-------------|
400400
| `tree` | `ComarkTree` | — | **Required.** The parsed tree returned by `parse()` |
401-
| [`components`](#code-components) | `Record<string, ComponentType>` | `{}` | Custom React component mappings |
402-
| [`componentsManifest`](#code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver for lazy-loaded components |
401+
| [`components`](#code-comark-props-code-components) | `Record<string, ComponentType>` | `{}` | Custom React component mappings |
402+
| [`componentsManifest`](#code-comark-props-code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver for lazy-loaded components |
403403
| [`streaming`](#streaming) | `boolean` | `false` | Enable streaming mode |
404-
| [`caret`](#caret) | `boolean \| { class: string }` | `false` | Append a blinking caret to the last text node |
405-
| [`data`](#code-data) | `Record<string, unknown>` | `undefined` | Runtime values referenced from markdown via `:prop="data.path"` |
404+
| [`caret`](#streaming-caret) | `boolean \| { class: string }` | `false` | Append a blinking caret to the last text node |
405+
| [`data`](#code-comark-props-code-data) | `Record<string, unknown>` | `undefined` | Runtime values referenced from markdown via `:prop="data.path"` |
406406
| `className` | `string` | `undefined` | CSS class for the wrapper `<div>` |
407407

408408
### `defineComarkRendererComponent`
@@ -449,9 +449,9 @@ export default async function Page({ params }: { params: { slug: string } }) {
449449

450450
| Option | Type | Default | Description |
451451
|--------|------|---------|-------------|
452-
| [`extends`](#inheritance) | `ReturnType<typeof defineComarkRendererComponent>` | `undefined` | Inherit component mappings from another renderer |
452+
| [`extends`](#code-comarkrenderer-code-definecomarkrenderercomponent-inheritance) | `ReturnType<typeof defineComarkRendererComponent>` | `undefined` | Inherit component mappings from another renderer |
453453
| `name` | `string` | `undefined` | Component name for debugging |
454-
| [`components`](#code-components) | `Record<string, ComponentType>` | `{}` | Custom React component mappings |
454+
| [`components`](#code-comark-props-code-components) | `Record<string, ComponentType>` | `{}` | Custom React component mappings |
455455
| `className` | `string` | `undefined` | Additional CSS classes for the wrapper div |
456456

457457
#### Inheritance

‎docs/content/3.rendering/6.svelte.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,13 @@ Pass markdown content via the `markdown` prop:
6969
| Prop | Type | Default | Description |
7070
|------|------|---------|-------------|
7171
| `markdown` | `string` | `''` | Markdown content to parse and render |
72-
| [`options`](#code-options) | `ParseOptions` | `{}` | Parser options (autoUnwrap, autoClose, etc.) |
73-
| [`plugins`](#code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
74-
| [`components`](#code-components) | `Record<string, Component>` | `{}` | Custom Svelte component mappings |
75-
| [`componentsManifest`](#code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver |
72+
| [`options`](#code-comark-props-code-options) | `ParseOptions` | `{}` | Parser options (autoUnwrap, autoClose, etc.) |
73+
| [`plugins`](#code-comark-props-code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
74+
| [`components`](#code-comark-props-code-components) | `Record<string, Component>` | `{}` | Custom Svelte component mappings |
75+
| [`componentsManifest`](#code-comark-props-code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver |
7676
| [`streaming`](#streaming) | `boolean` | `false` | Enable streaming mode |
77-
| [`caret`](#caret) | `boolean \| { class: string }` | `false` | Append caret to last text node |
78-
| [`data`](#code-data) | `Record<string, unknown>` | `undefined` | Runtime values referenced from markdown via `:prop="data.path"` |
77+
| [`caret`](#streaming-caret) | `boolean \| { class: string }` | `false` | Append caret to last text node |
78+
| [`data`](#code-comark-props-code-data) | `Record<string, unknown>` | `undefined` | Runtime values referenced from markdown via `:prop="data.path"` |
7979
| `class` | `string` | `''` | CSS class for wrapper element |
8080

8181
#### `options`
@@ -280,11 +280,11 @@ export const load: PageLoad = async ({ params, fetch }) => {
280280
| Prop | Type | Default | Description |
281281
|------|------|---------|-------------|
282282
| `tree` | `ComarkTree` | — | **Required.** The parsed tree returned by `parse()` |
283-
| [`components`](#code-components) | `Record<string, Component>` | `{}` | Custom Svelte component mappings |
284-
| [`componentsManifest`](#code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver for lazy-loaded components |
283+
| [`components`](#code-comark-props-code-components) | `Record<string, Component>` | `{}` | Custom Svelte component mappings |
284+
| [`componentsManifest`](#code-comarkrenderer-code-componentsmanifest) | `ComponentManifest` | `undefined` | Dynamic component resolver for lazy-loaded components |
285285
| [`streaming`](#streaming) | `boolean` | `false` | Enable streaming mode |
286-
| [`caret`](#caret) | `boolean \| { class: string }` | `false` | Append a blinking caret to the last text node |
287-
| [`data`](#code-data) | `Record<string, unknown>` | `undefined` | Runtime values referenced from markdown via `:prop="data.path"` |
286+
| [`caret`](#streaming-caret) | `boolean \| { class: string }` | `false` | Append a blinking caret to the last text node |
287+
| [`data`](#code-comark-props-code-data) | `Record<string, unknown>` | `undefined` | Runtime values referenced from markdown via `:prop="data.path"` |
288288
| `class` | `string` | `''` | CSS class for wrapper element |
289289

290290
### `componentsManifest`

‎docs/content/3.rendering/7.ansi.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ This is a bold statement with a link (https://example.com).
7979

8080
| Option | Type | Default | Description |
8181
| --- | --- | --- | --- |
82-
| [`plugins`](#code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
83-
| [`components`](#code-components) | `Record<string, fn>` | `{}` | Custom component renderers |
84-
| [`data`](#code-data) | `Record<string, any>` | `undefined` | Data passed to component renderers |
82+
| [`plugins`](#code-render-options-code-plugins) | `ComarkPlugin[]` | `[]` | Array of plugins |
83+
| [`components`](#code-render-options-code-components) | `Record<string, fn>` | `{}` | Custom component renderers |
84+
| [`data`](#code-render-options-code-data) | `Record<string, any>` | `undefined` | Data passed to component renderers |
8585
| `colors` | `boolean` | `true`* | Emit ANSI escape codes |
8686
| `width` | `number` | `80` | Terminal width for HR and code block headers |
8787

@@ -164,7 +164,7 @@ const out2 = await render('# Document 2\n\n...')
164164

165165
#### Options
166166

167-
Same as [`render()`](#options).
167+
Same as [`render()`](#code-render-options).
168168

169169
---
170170

@@ -223,7 +223,7 @@ await log('# Document 2\n\n...')
223223

224224
#### Options
225225

226-
Same as [`log()`](#log).
226+
Same as [`log()`](#code-log).
227227

228228
---
229229

@@ -254,8 +254,8 @@ process.stdout.write(output)
254254

255255
| Option | Type | Default | Description |
256256
| --- | --- | --- | --- |
257-
| [`components`](#code-components) | `Record<string, fn>` | `{}` | Custom component renderers |
258-
| [`data`](#code-data) | `Record<string, any>` | — | Data passed to component renderers |
257+
| [`components`](#code-render-options-code-components) | `Record<string, fn>` | `{}` | Custom component renderers |
258+
| [`data`](#code-render-options-code-data) | `Record<string, any>` | — | Data passed to component renderers |
259259
| `colors` | `boolean` | `true`* | Emit ANSI escape codes |
260260
| `width` | `number` | `80` | Terminal width for HR and code block headers |
261261

‎docs/content/4.plugins/1.built-in/headings.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ The description check always looks at the node **immediately after** the title
6060

6161
| Option | Type | Default | Description |
6262
|---|---|---|---|
63-
| [`titleTag`](#code-titletag) | `string` | `'h1'` | Element tag to extract as the page title |
64-
| [`descriptionTag`](#code-descriptiontag) | `string` | `'p'` | Element tag to extract as the page description |
65-
| [`remove`](#code-remove) | `boolean` | `true` | Remove extracted nodes from the tree after extraction |
63+
| [`titleTag`](#options-code-titletag) | `string` | `'h1'` | Element tag to extract as the page title |
64+
| [`descriptionTag`](#options-code-descriptiontag) | `string` | `'p'` | Element tag to extract as the page description |
65+
| [`remove`](#options-code-remove) | `boolean` | `true` | Remove extracted nodes from the tree after extraction |
6666

6767
### `titleTag`
6868

0 commit comments

Comments
 (0)