Markdown syntax
Markdown is the syntax used to encode pages.
See this guide to learn the basic syntax.
Some other links where one can find more about Markdown syntax and examples:
- Basic formatting syntax
- Advanced formatting syntax
- Tags
- Callouts are used to highlight some part of a page (see examples below).
Callout examples
Info
Default title
Can callouts be nested?
Yes!, they can. And collapsed!
You can even use multiple layers of nesting.
Note
Aliases: “note”
Abstract
Aliases: “abstract”, “summary”, “tldr”
Info
Aliases: “info”
Todo
Aliases: “todo”
Hint
Aliases: “tip”, “hint”, “important”
Success
Aliases: “success”, “check”, “done”
Question
Aliases: “question”, “help”, “faq”
Warning
Aliases: “warning”, “attention”, “caution”
Failure
Aliases: “failure”, “missing”, “fail”
Danger
Aliases: “danger”, “error”
Bug
Aliases: “bug”
Example
Aliases: “example”
Quote
Aliases: “quote”, “cite”