Syntax ¶
LeoMoon Wiki-Go uses Markdown for formatting content. Here are some examples:
Headings ¶
Markdown | Rendered Output |
---|---|
# Heading level 1 | Heading level 1 |
## Heading level 2 | Heading level 2 |
### Heading level 3 | Heading level 3 |
#### Heading level 4 | Heading level 4 |
##### Heading level 5 | Heading level 5 |
###### Heading level 6 | Heading level 6 |
Paragraphs ¶
To create paragraphs, use a blank line to separate one or more lines of text.
Line Breaks ¶
To create a line break or new line (<br>), end a line with two or more spaces, and then type return.
Emphasis ¶
You can add emphasis by making text bold or italic.
Bold ¶
To bold text, add two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.
Markdown | Rendered Output |
---|---|
Example **bold** text. | Example bold text. |
Example __bold__ text. | Example bold text. |
Example**bold**text | Exampleboldtext |
Italic ¶
To italicize text, add one asterisk or underscore before and after a word or phrase. To italicize the middle of a word for emphasis, add one asterisk without spaces around the letters.
Markdown | Rendered Output |
---|---|
Example *italicized* text. | Example italicized text. |
Example _italicized_ text. | Example italicized text. |
Example*italicized*text | Exampleitalicizedtext |
Bold and Italic ¶
To emphasize text with bold and italics at the same time, add three asterisks or underscores before and after a word or phrase. To bold and italicize the middle of a word for emphasis, add three asterisks without spaces around the letters.
Markdown | Rendered Output |
---|---|
This text is ***really important***. | This text is really important. |
This text is ___really important___. | This text is really important. |
This text is __*really important*__. | This text is really important. |
This text is **_really important_**. | This text is really important. |
This is really***very***important text. | This is reallyveryimportant text. |
Blockquotes ¶
To create a blockquote, add a > in front of a paragraph.
> Dorothy followed her through many of the beautiful rooms in her castle.
The rendered output looks like this:
Dorothy followed her through many of the beautiful rooms in her castle.
Blockquotes with Multiple Paragraphs ¶
Blockquotes can contain multiple paragraphs. Add a > on the blank lines between the paragraphs.
> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
The rendered output looks like this:
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
Nested Blockquotes ¶
Blockquotes can be nested. Add a >> in front of the paragraph you want to nest.
> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
The rendered output looks like this:
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
Blockquotes with Other Elements ¶
Blockquotes can contain other Markdown formatted elements. Not all elements can be used — you'll need to experiment to see which ones work.
> #### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
> *Everything* is going according to **plan**.
The rendered output looks like this:
The quarterly results look great!
- Revenue was off the chart.
- Profits were higher than ever.
Everything is going according to plan.
Lists and Task Lists ¶
Regular Lists ¶
Markdown supports both ordered and unordered lists. You can also nest lists to create sub-items.
Unordered Lists use asterisks (*
), plus signs (+
), or hyphens (-
):
- Item 1
- Sub-item 1
- Sub-item 2
- Item 2
- Sub-item 1
- Sub-sub-item 1
- Sub-sub-item 2
- Sub-item 2
- Sub-item 1
- Item 3
Ordered Lists use numbers followed by a period:
- First item
- Sub-item 1
- Sub-item 2
- Second item
- Sub-item 1
- Sub-item 2
- Third item
You can also mix ordered and unordered lists:
- First item
- Sub-item 1
- Sub-item 2
- Second item
- Sub-item 1
- Sub-sub-item 1
- Sub-sub-item 2
- Sub-item 2
- Sub-item 1
- Third item
Task Lists ¶
Markdown supports task lists, which are useful for tracking tasks or to-do items. Use square brackets to denote the state of each task: [x]
for completed tasks and [ ]
for incomplete tasks. Task lists can also include nested items.
Example Task List:
- Write the press release
- Draft
- Review
- Finalize
- Update the website
- Update home page
- Update contact information
This task list shows that the press release has been fully completed, while the website update and media contact tasks are still pending with some sub-tasks.
Extended Syntax ¶
These are extended markdown features in LeoMoon Wiki-Go.
Text Highlight ¶
To highlight text, add two equal signs before and after a word or phrase. To highlight the middle of a word for emphasis, add two equal signs without spaces around the letters.
Superscript and Subscript ¶
To create superscript text in Markdown, use the caret symbol (^
). For example, 1^st^
renders as 1st. For subscript text, use the tilde symbol (~
). For instance, h~2~o
renders as h2o.
Strikethrough ¶
To create strikethrough text in Markdown, use double tildes (~~
). For example, ~~incorrect~~
renders as incorrect.
Typographic Shortcodes ¶
(c)
: Replaced with © (Copyright symbol).(r)
: Replaced with ® (Registered trademark symbol).(tm)
: Replaced with ™ (Trademark symbol).(p)
: Replaced with ¶ (Paragraph symbol).+-
: Replaced with ± (Plus-minus symbol)....
: Replaced with … (Ellipsis).1/2
: Replaced with ½ (One-half).1/4
: Replaced with ¼ (One-quarter).3/4
: Replaced with ¾ (Three-quarters).
Tables ¶
Header 1 | Header 2 |
---|---|
Cell 1 | Cell 2 |
Cell 3 | Cell 4 |
Footnotes ¶
Here's a sentence with a footnote.1
Math Equations (MathJax) ¶
Inline math: $E=mc^2$
Block math (requires blank lines before and after):
$$
\frac{d}{dx}(x^n) = nx^{n-1}
$$
Diagrams (Mermaid) ¶
Details/Summary (Collapsible Content) ¶
You can create collapsible sections using the details code fence:
Details Title
You can include any Markdown content here:
- Lists
- Bold text
- Links
- And more…
Video Embedding ¶
You can embed videos from various sources:
YouTube Videos: ¶
YouTube Video
This embedded video is not available in print. You can view it online at:
Vimeo Videos: ¶
Vimeo Video
This embedded video is not available in print. You can view it online at:
Local MP4 Files: ¶
After uploading a video file through the attachments feature, you can insert it using files tab:
```mp4
your-video-filename.mp4
```
Forced RTL/LTR ¶
You can force a specific direction for a section of text by adding the direction shortcode:
Shortcodes ¶
LeoMoon Wiki-Go supports special shortcodes for dynamic content:
Statistics Shortcode:
:::stats count=*:::
:::stats recent=5:::
These shortcodes display document statistics like total count or recent changes.
-
This is the footnote. ↩︎
Comments
Please login to leave a comment.
No comments yet. Be the first to comment!