a1db08f32e
Some checks failed
Deploy Docs / deploy (push) Failing after 23s
Strips docs/ prefix from Tolaria-generated links, collapses /index suffixes, removes .md extensions, and produces root-relative URLs (/page/path/) that work from any page regardless of depth. Images get root-relative asset paths.
1.6 KiB
1.6 KiB
| icon |
|---|
| simple/markdown |
Markdown in 5min
Introduction to Markdown Language
Markdown is a simple language to build web pages. It is easier to read and write than HTML (the language web browsers read) and so we use it to write articles. You can use this reference to help you write posts and pages directly in our repository where the source documents for this wiki are held. See docs/contributing/index for more.
Headers
# H1 Header
## H2 Header
### H3 Header
#### H4 Header
##### H5 Header
###### H6 Header
Text formatting
**bold text**
*italic text*
***bold and italic***
~~strikethrough~~
`inline code`
Links and images
[Link text](https://example.com)
[Link with title](https://example.com "Hover title")
Lists
Unordered:
- Item 1
- Item 2
- Nested item
Ordered:
1. First item
2. Second item
3. Third item
Blockquotes
> This is a blockquote
> Multiple lines
>> Nested quote
Code blocks
```javascript
function hello() {
console.log("Hello, world!");
}
```
Tables
| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1 | Data | Data |
| Row 2 | Data | Data |
Horizontal rule
---
or
***
or
___
Task lists
- [x] Completed task
- [ ] Incomplete task
- [ ] Another task
Escaping characters
Use backslash to escape: \* \_ \# \`
Line breaks
End a line with two spaces
to create a line break.
Or use a blank line for a new paragraph.