Skip to content
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.

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

Update syntax guide about comments #414

Merged
merged 2 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/docset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ toc:
- file: admonitions.md
- file: automated_settings.md
- file: code.md
- file: comments.md
- file: conditionals.md
- file: dropdowns.md
- file: example_blocks.md
Expand Down
15 changes: 15 additions & 0 deletions docs/syntax/comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Comments

## Single line comments

Use `%` to add single-line comments.

```markdown
% This is a comment
```

Make sure to add a space after the `%`.

::::{note}
Currently multi-line comments are not supported.
::::
6 changes: 0 additions & 6 deletions docs/syntax/sundries.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,3 @@ using `\` at the end of a line.

Same as using `<hr>` HTML tag:
***

## Comments

% Here is a comment

You can use `%` to add comments in the markdown. Those comment will not be rendered in the HTML output. Look at the markdown source to see the comment above this paragraph.