Skip to content

Tweak doc markdown subset description #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2025
Merged

Tweak doc markdown subset description #299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/docs/documentation.mdz
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ Janet's built-in documentation viewer, @code`(doc)`, understands a subset of
Markdown and will indent docstrings that use this subset in an intelligent way.
The subset of Markdown includes:

@ul{@li{numbered and unnumbered lists}
@li{codeblocks}
@li{blockquotes}}
@ul{@li{top-level paragraphs}
@li{single-level ordered and unordered lists}
@li{code blocks}}

Other Markdown-formatted text (e.g. code spans) are simply treated as ordinary
text.
Expand Down