website/docs/notes/markdown.md at main · desertthunder.dev/noteleaf

cli + tui to publish to leaflet (wip) & manage tasks, notes & watch/read lists 🍃

charm leaflet readability golang

noteleaf / website / docs / notes / markdown.md

at main 103 lines 1.3 kB view raw view rendered

  1---
  2title: Markdown Support
  3sidebar_label: Markdown
  4description: Reference for GitHub-Flavored Markdown features.
  5sidebar_position: 6
  6---
  7
  8# Markdown Support
  9
 10Noteleaf notes support full GitHub-Flavored Markdown:
 11
 12## Headers
 13
 14```markdown
 15# Level 1
 16## Level 2
 17### Level 3
 18```
 19
 20## Text Formatting
 21
 22```markdown
 23**bold**
 24*italic*
 25***bold and italic***
 26~~strikethrough~~
 27`inline code`
 28```
 29
 30## Lists
 31
 32```markdown
 33- Unordered item
 34- Another item
 35  - Nested item
 36
 371. Ordered item
 382. Second item
 39   1. Nested ordered
 40```
 41
 42## Task Lists
 43
 44```markdown
 45- [x] Completed task
 46- [ ] Pending task
 47- [ ] Another pending
 48```
 49
 50## Links
 51
 52```markdown
 53[Link text](https://example.com)
 54[Reference link][ref]
 55
 56[ref]: https://example.com
 57```
 58
 59## Images
 60
 61```markdown
 62![Alt text](path/to/image.png)
 63![Remote image](https://example.com/image.png)
 64```
 65
 66## Code Blocks
 67
 68````markdown
 69```python
 70def hello():
 71    print("Hello, world!")
 72```
 73
 74```javascript
 75const greet = () => console.log("Hello!");
 76```
 77````
 78
 79## Tables
 80
 81```markdown
 82| Header 1 | Header 2 |
 83|----------|----------|
 84| Cell 1   | Cell 2   |
 85| Cell 3   | Cell 4   |
 86```
 87
 88## Blockquotes
 89
 90```markdown
 91> This is a quote
 92> spanning multiple lines
 93>
 94> With multiple paragraphs
 95```
 96
 97## Horizontal Rules
 98
 99```markdown
100---
101***
102___
103```