Skip to content

Commit 19d7505

Browse files
authored
Update syntax guide about comments (#414)
* Update syntax guide about comments * update TOC
1 parent be9cd4f commit 19d7505

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

docs/docset.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ toc:
7272
- file: admonitions.md
7373
- file: automated_settings.md
7474
- file: code.md
75+
- file: comments.md
7576
- file: conditionals.md
7677
- file: dropdowns.md
7778
- file: example_blocks.md

docs/syntax/comments.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Comments
2+
3+
## Single line comments
4+
5+
Use `%` to add single-line comments.
6+
7+
```markdown
8+
% This is a comment
9+
```
10+
11+
Make sure to add a space after the `%`.
12+
13+
::::{note}
14+
Currently multi-line comments are not supported.
15+
::::

docs/syntax/sundries.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,3 @@ using `\` at the end of a line.
3232

3333
Same as using `<hr>` HTML tag:
3434
***
35-
36-
## Comments
37-
38-
% Here is a comment
39-
40-
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.

0 commit comments

Comments
 (0)