Skip to content

Commit 98afd22

Browse files
updated information on ignorable comments
1 parent c6b878d commit 98afd22

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
33
author: André Dietrich
44
5-
date: 06/03/2025
6-
version: 30.0.1
5+
date: 14/04/2025
6+
version: 31.0.0
77
language: en
88
narrator: UK English Female
99
@@ -2497,6 +2497,41 @@ of the different possible settings. For [PeerTube](https://peertube.tv) and
24972497

24982498
********************************************************************************
24992499

2500+
## Ignoreable Comments
2501+
2502+
--{{0}}--
2503+
As you have seen in the previous examples, you can use HTML comments to define certain settings within your course or to change the styling of elements.
2504+
2505+
--{{1}}--
2506+
However, since it is pretty difficult to separate ordinary comments from comments with HTML-parameters within, we have now added a special comment type, which is defined by at least three dashes.
2507+
2508+
{{1}}
2509+
``` markdown
2510+
<!---
2511+
This is a comment, which will be ignored by the parser.
2512+
It will not be rendered in the final document.
2513+
It is only visible in the source code.
2514+
--->
2515+
```
2516+
2517+
--{{2}}--
2518+
At least means, that you can use more than three dashes...
2519+
2520+
{{2}}
2521+
``` markdown
2522+
<!---------------------------------------------------------
2523+
This style of comment might be visually more appealing ...
2524+
---------------------------------------------------------->
2525+
```
2526+
2527+
--{{3}}--
2528+
And of course this can be used to comment out content or settings.
2529+
2530+
{{3}}
2531+
``` markdown
2532+
<!--- style="color: red" class="to be ignored" --->
2533+
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
2534+
```
25002535

25012536
## Math & Formulas
25022537

0 commit comments

Comments
 (0)