Dorcs

Special Markdown

Table of Contents

Create a table of contents using the placeholder:

[[TOC]]

Result:

Table of Contents Root Navigation

Create a table of contents for the root navigation using the placeholder:

[[TOC-ROOT]]

Result:

Filtered Table of Contents

Create a table of contents with a maximum depth limit:

[[TOC:1]]

This will only show headings up to level 2 (H1 and H2). You can specify any depth from 1 to 6.

Result:

Alert Blocks

dorcs supports GitHub-style alert blocks for callouts and important information:

> **ALERT:NOTE**
> This is a note alert block.
> It can contain multiple lines.

> [!TIP]
> This is a tip alert block.
> Use it for helpful suggestions.

> [!IMPORTANT]
> This is an important alert block.
> Use it for critical information.

> [!WARNING]
> This is a warning alert block.
> Use it to warn users about potential issues.

> [!CAUTION]
> This is a caution alert block.
> Use it for dangerous or risky operations.

Result:

Note

This is a note alert block.
It can contain multiple lines.

Tip

This is a tip alert block.
Use it for helpful suggestions.

Important

This is an important alert block.
Use it for critical information.

Warning

This is a warning alert block.
Use it to warn users about potential issues.

Caution

This is a caution alert block.
Use it for dangerous or risky operations.

Display breadcrumb navigation showing the path to the current page:

[[BREADCRUMBS]]

Result:

Children Pages

Display all children pages and folders in the current section:

[[CHILDREN]]

This shows all direct children (pages and subfolders) of the current page/folder, with descriptions and indicators for directories.

Result:

Sibling Pages

Display links to sibling pages (pages at the same level):

[[SIBLINGS]]

Result:

Display related pages based on shared tags:

[[RELATED]]

Result:

Recently Updated Pages

Display a list of recently updated pages:

[[RECENT]]

Result:

Page Tags

Display tags for the current page:

[[TAGS]]

Result:

Tags:

Site Index

Display a full alphabetical index of all pages:

[[INDEX]]

Result:

Publication Date

Display the publication date from front matter:

[[DATE]]

or

[[PUBLISHED]]

Result:

Last Updated Date

Display the last modified date of the page:

[[LAST-UPDATED]]

Result:

Author Information

Display author information from front matter:

[[AUTHOR]]

Result:

Note

Add author: "Author Name" to your front matter to use this feature.

Page Summary

Display the page summary (from description or first paragraph):

[[SUMMARY]]

Result:

Special markdown features

Pages by Tag

Display all pages grouped by their tags:

[[PAGES-BY-TAG]]

Result: