From 0cb4db1f8af091fed9dee7ac98731e65102c62db Mon Sep 17 00:00:00 2001
From: Liam Thompson <leemthompo@gmail.com>
Date: Tue, 4 Feb 2025 17:02:17 +0100
Subject: [PATCH 1/2] Update syntax guide about comments

---
 docs/syntax/comments.md | 15 +++++++++++++++
 docs/syntax/sundries.md |  6 ------
 2 files changed, 15 insertions(+), 6 deletions(-)
 create mode 100644 docs/syntax/comments.md

diff --git a/docs/syntax/comments.md b/docs/syntax/comments.md
new file mode 100644
index 000000000..b26972208
--- /dev/null
+++ b/docs/syntax/comments.md
@@ -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.
+::::
\ No newline at end of file
diff --git a/docs/syntax/sundries.md b/docs/syntax/sundries.md
index 6e6eb552c..8c5f417e7 100644
--- a/docs/syntax/sundries.md
+++ b/docs/syntax/sundries.md
@@ -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.

From 4489ae5fa617048ab58391781e89f200e7cd4ff0 Mon Sep 17 00:00:00 2001
From: Liam Thompson <leemthompo@gmail.com>
Date: Tue, 4 Feb 2025 17:08:59 +0100
Subject: [PATCH 2/2] update TOC

---
 docs/docset.yml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/docset.yml b/docs/docset.yml
index a8a851bdf..dcf4a1dc5 100644
--- a/docs/docset.yml
+++ b/docs/docset.yml
@@ -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