With Markdown, in addition to headings and bullet points, you can bold text and add links.
This will also make your text more readable.
Bold Text
Enclosing text in ** (two asterisks) will bold text.
Enclosing text in * (one asterisk) will italicize text.
There are instances where you must add a space before and after the asterisk.
Example:
This is *italicized* text.
This is **bold** text.
This is ***Italics and Bold Text*** text.
Anchor
Use an anchor to jump to a specific page.
You can note an anchor in the following format:.
Example:
[jump](#Anchor to jump)
If the URL is a note published on Kibela, the link text will be automatically noted as the title.
To open a link in a separate tab, write the URL in "URL" and the title in "LINK".
<a href="URL" target="_blank">LINK</a>
Tables
Create tables by separating headings and content with | and separate headings and content with -- and |.
Example:
Heading 1 | Heading 2 | Heading 3
-- | -- | -- |
Content 1 | Content 2 | Content 3
To paste spreadsheet data from Excel or Google, you can use CSV format.
For details, please see this page.
Code
To enter lines of code or file names, enclose in ` (backticks).
Code notation will be noted in monospaced font.
Code Blocks
To create code blocks, use fenced code blocks by using ```(3 backticks) or ~ ~ ~ (three tildes) on the lines before and after the code block.
You can specify a language after the backticks or tilde to enable syntax highlighting.
The language can also be auto-detected from the file name, however this may not always be 100% accurate. In that case, you can explicitly set the language with `language: filename` such as `ruby:Gemfile`
Example:
PlantUML Syntax
To use PlantUML, use the label ```{plantuml}.
With PlantUML, you can create UML diagrams such as sequence and component diagrams.
Example:
*We used to support the label ```plantuml``` but we currently encourage users to use ```{plantuml}```. For sample PlantUML, please refer to Real World PlantUML (link).
LaTeX Syntax
To use LaText syntax, use the label ```{latext}``` to write equations with MathJax. In addition, use `$`...` $` for inlineMath, which allows you to embed equations in text.
Example:
For sample LaTeX notations by MathJax, please refer to the MathJax basic tutorial and quick reference.