How to use Markdown
Miscellaneous¶
In this section, we do not delve into the basic syntax of Markdown. Instead, our emphasis is on introducing commonly used extended syntax.
Task Checklist¶
<!-- (blank line) -->
- [x] Completed
- [ ] Uncompleted
- Completed
- Uncompleted
Admonitions¶
Admonitions are block elements used to highlight specific types of content, like warnings, tips, notes, etc.
Collapsible Blocks¶
After enabling the Details extension, if an admonition block uses ??? instead of !!!, the admonition will be rendered as a collapsible block, with a small toggle button on the right side to switch its collapsed state.
??? note "Optional Details"
This is a collapsible admonition.
Optional Details
This is a collapsible admonition.
Adding a + after ??? will set the collapsible block to be expanded by default.
???+ note "Optional Details"
This is a collapsible admonition.
Optional Details
This is a collapsible admonition.
Inline Blocks¶
Admonitions can also be rendered as inline blocks (useful for sidebars or similar contexts). By using the inline and end modifiers, admonitions can be positioned to the left or right of other elements, respectively. Important note: Admonitions with the inline modifier must be declared before the content block they are intended to appear beside. If there is insufficient space, such as when viewing on a mobile device, the admonition will be forced to stretch to the full width of the viewport.
Left Inline Block
This is an inline block modified only with inline,
so it will be rendered to the left of the text.
This can also be used to display information in a sidebar.
!!! info inline "Left Inline Block"
This is an inline block modified only with `inline`,
so it will be rendered to the left of the text.
This can also be used to display information in a sidebar.
Right Inline Block
This is an inline block modified with inline end,
so it will be rendered to the right of the text.
This can be used to display information in a sidebar.
!!! info inline end "Right Inline Block"
This is an inline block modified with `inline end`,
so it will be rendered to the right of the text.
This can be used to display information in a sidebar.
Supported Options¶
!!! tldr "A title"
Some contents
A title
Some contents
Here, tldr can be replaced by other keywords to create various types of tooltips:
!!! success "A title"
Some contents
A title
Some contents
!!! tip "A title"
Some contents
A title
Some contents
!!! info "A title"
Some contents
A title
Some contents
!!! question "A title"
Some contents
A title
Some contents
!!! warning "A title"
Some contents
A title
Some contents
!!! danger "A title"
Some contents
A title
Some contents
!!! example "A title"
Some contents
A title
Some contents
!!! quote "A title"
Some contents
A title
Some contents
Button¶
[Our Wiki Home](../../index.md){ .md-button }
[Our Wiki Home](../../index.md){ .md-button .md-button--primary }
[Our Wiki Home :fontawesome-solid-paper-plane:](../../index.md){ .md-button }
Content tabs¶
Please refer to: https://owenllli.github.io/language/markdown/buttons/