Skip to content

Commit 36f6651

Browse files
committed
Fix dead links in documentation
Update relative links to use correct paths after VitePress migration: - extensions.md -> /extensions/ - cookbook.md -> /cookbook/ - profiles.md -> /guide/profiles - Remove reference to deleted profile-filter-examples.md - Fix cookbook-*.md -> ./plaintext, ./markdown, ./ansi
1 parent c362fda commit 36f6651

7 files changed

Lines changed: 16 additions & 18 deletions

File tree

docs/cookbook/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Common recipes and customizations for djot-php.
2929

3030
## External Links
3131

32-
> **Tip:** Use the built-in [ExternalLinksExtension](extensions.md#externallinksextension) for common cases.
32+
> **Tip:** Use the built-in [ExternalLinksExtension](/extensions/#externallinksextension) for common cases.
3333
3434
Open external links in a new tab with security attributes:
3535

@@ -361,7 +361,7 @@ $converter->on('render.code_block', function (RenderEvent $event): void {
361361

362362
## Table of Contents Generation
363363

364-
> **Tip:** Use the built-in [TableOfContentsExtension](extensions.md#tableofcontentsextension) for common cases.
364+
> **Tip:** Use the built-in [TableOfContentsExtension](/extensions/#tableofcontentsextension) for common cases.
365365
366366
Generate a table of contents from headings:
367367

@@ -502,7 +502,7 @@ echo $converter->convert($djot);
502502

503503
## Heading Anchors
504504

505-
> **Tip:** Use the built-in [HeadingPermalinksExtension](extensions.md#headingpermalinksextension) for clickable permalink anchors.
505+
> **Tip:** Use the built-in [HeadingPermalinksExtension](/extensions/#headingpermalinksextension) for clickable permalink anchors.
506506
507507
Add anchor links to headings:
508508

@@ -622,7 +622,7 @@ $converter->on('render.raw_inline', function (RenderEvent $event) use ($allowedT
622622

623623
## Lazy Loading Images
624624

625-
> **Tip:** Use the built-in [DefaultAttributesExtension](extensions.md#defaultattributesextension) for this.
625+
> **Tip:** Use the built-in [DefaultAttributesExtension](/extensions/#defaultattributesextension) for this.
626626
627627
Add native lazy loading to all images:
628628

@@ -1277,7 +1277,7 @@ Extend Djot with custom inline syntax by registering patterns on the InlineParse
12771277

12781278
### @Mentions
12791279

1280-
> **Tip:** Use the built-in [MentionsExtension](extensions.md#mentionsextension) for common cases.
1280+
> **Tip:** Use the built-in [MentionsExtension](/extensions/#mentionsextension) for common cases.
12811281
12821282
Convert `@username` to profile links:
12831283

@@ -1801,9 +1801,9 @@ Useful boolean attributes for djot elements:
18011801
## Alternative Output Formats
18021802

18031803
For detailed customization of alternative renderers, see:
1804-
- [PlainText Cookbook](cookbook-plaintext.md) - PlainTextRenderer customizations
1805-
- [Markdown Cookbook](cookbook-markdown.md) - MarkdownRenderer customizations
1806-
- [ANSI Cookbook](cookbook-ansi.md) - AnsiRenderer customizations
1804+
- [PlainText Cookbook](./plaintext) - PlainTextRenderer customizations
1805+
- [Markdown Cookbook](./markdown) - MarkdownRenderer customizations
1806+
- [ANSI Cookbook](./ansi) - AnsiRenderer customizations
18071807

18081808
### Plain Text Extraction
18091809

docs/guide/profiles.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,6 @@ $html = $converter->convert('Check [this link](https://example.com)!');
160160
// Link converted to text, URL removed
161161
```
162162

163-
See [Profile Filter Examples](profile-filter-examples.md) for a complete list of how each element type is converted.
164-
165163
## Link Policies
166164

167165
Control how links are rendered:

docs/guide/syntax.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -785,7 +785,7 @@ I :heart: Djot
785785
<p>I <span class="symbol">heart</span> Djot</p>
786786
```
787787

788-
Note: Symbol rendering can be customized via events. See the [Cookbook](cookbook.md) for examples.
788+
Note: Symbol rendering can be customized via events. See the [Cookbook](/cookbook/) for examples.
789789

790790
### Footnotes
791791

@@ -937,7 +937,7 @@ Definitions can span multiple lines if continuation lines are indented:
937937
designed to be displayed in a web browser
938938
```
939939

940-
**Note:** This feature works alongside the inline span approach documented in the [cookbook](cookbook.md#abbreviations). The definition-based approach automatically applies to all matching text, while the inline `[HTML]{abbr="..."}` approach allows overriding specific occurrences.
940+
**Note:** This feature works alongside the inline span approach documented in the [cookbook](/cookbook/#abbreviations). The definition-based approach automatically applies to all matching text, while the inline `[HTML]{abbr="..."}` approach allows overriding specific occurrences.
941941

942942
## Escaping
943943

docs/guide/why-djot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,5 +293,5 @@ Djot is the better choice when:
293293

294294
- [Official Djot Syntax Reference](https://djot.net/)
295295
- [Djot Playground](https://djot.net/playground/)
296-
- [Syntax Guide](syntax.md) - This library's syntax documentation
297-
- [Converters](converters.md) - Migration tools
296+
- [Syntax Guide](./syntax) - This library's syntax documentation
297+
- [Converters](./converters) - Migration tools

docs/reference/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public function __construct(
2828
- `$warnings`: When `true`, collects warnings during parsing (see [Error Handling](#error-handling)).
2929
- `$strict`: When `true`, throws `ParseException` on parse errors (see [Error Handling](#error-handling)).
3030
- `$safeMode`: When `true` or a `SafeMode` instance, enables XSS protection (see [Safe Mode](#safe-mode)).
31-
- `$profile`: A `Profile` instance for feature restriction (see [Profiles](profiles.md)).
31+
- `$profile`: A `Profile` instance for feature restriction (see [Profiles](/guide/profiles)).
3232
- `$significantNewlines`: When `true`, enables markdown-like parsing where block elements can interrupt paragraphs (see [Significant Newlines Mode](#significant-newlines-mode)).
3333

3434
### Factory Methods
@@ -875,4 +875,4 @@ $converter = DjotConverter::withSignificantNewlines();
875875
$converter->getRenderer()->setSoftBreakMode(SoftBreakMode::Space);
876876
```
877877

878-
See [enhancements.md](enhancements.md#significant-newlines-mode) for upstream tracking.
878+
See [enhancements.md](./enhancements#significant-newlines-mode) for upstream tracking.

docs/reference/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Events are fired for each node type using the pattern `render.{node_type}`:
189189
- `render.paragraph`, `render.heading`, `render.code_block`, etc.
190190
- `render.link`, `render.image`, `render.emphasis`, `render.symbol`, etc.
191191

192-
See the [Cookbook](cookbook.md) for common customization recipes.
192+
See the [Cookbook](/cookbook/) for common customization recipes.
193193

194194
### Adding New Syntax
195195

docs/reference/enhancements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -890,7 +890,7 @@ is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.</p>
890890
- Case-sensitive matching (HTML ≠ html)
891891
- Word-boundary aware (HTML won't match HTMLElement or XHTML)
892892
- Multi-line definitions supported with indentation
893-
- Works alongside the inline span approach (`[HTML]{abbr="..."}`) from the [cookbook](cookbook.md#abbreviations)
893+
- Works alongside the inline span approach (`[HTML]{abbr="..."}`) from the [cookbook](/cookbook/#abbreviations)
894894

895895
**Multi-line definition example:**
896896
```djot

0 commit comments

Comments
 (0)