diff options
| author | Dessalines <tyhou13@gmx.com> | 2020-02-17 20:48:17 -0500 |
|---|---|---|
| committer | Dessalines <tyhou13@gmx.com> | 2020-02-17 20:48:17 -0500 |
| commit | 29822c13af6eb531b21b4648805eb6ea78217e23 (patch) | |
| tree | 4f92c177132c09af6cfe56191da8666b429a3c3c /docs | |
| parent | 022d632e40795b8760209e0b1d40b62c8ffd8040 (diff) | |
Add a user guide. Fixes #543
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/SUMMARY.md | 1 | ||||
| -rw-r--r-- | docs/src/about_guide.md | 28 |
2 files changed, 29 insertions, 0 deletions
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index c2df6223..0514cbcd 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -4,6 +4,7 @@ - [Features](about_features.md) - [Goals](about_goals.md) - [Post and Comment Ranking](about_ranking.md) + - [Guide](about_guide.md) - [Administration](administration.md) - [Install with Docker](administration_install_docker.md) - [Install with Ansible](administration_install_ansible.md) diff --git a/docs/src/about_guide.md b/docs/src/about_guide.md new file mode 100644 index 00000000..426d659a --- /dev/null +++ b/docs/src/about_guide.md @@ -0,0 +1,28 @@ +# Lemmy Guide + +Start typing... + +- `@a_user_name` to get a list of usernames. +- `#a_community` to get a list of communities. +- `:emoji` to get a list of emojis. + +## Markdown Guide + +Type | Or | … to Get +--- | --- | --- +\*Italic\* | \_Italic\_ | _Italic_ +\*\*Bold\*\* | \_\_Bold\_\_ | **Bold** +\# Heading 1 | Heading 1 <br> ========= | # Heading 1 +\## Heading 2 | Heading 2 <br>--------- | ## Heading 2 +\[Link\](http://a.com) | \[Link\]\[1\]<br>⋮ <br>\[1\]: http://b.org | [Link](https://commonmark.org/) +!\[Image\](http://url/a.png) | !\[Image\]\[1\]<br>⋮ <br>\[1\]: http://url/b.jpg |  +\> Blockquote | | > Blockquote +\* List <br>\* List <br>\* List | \- List <br>\- List <br>\- List <br> | * List <br>* List <br>* List <br> +1\. One <br>2\. Two <br>3\. Three | 1) One<br>2) Two<br>3) Three | 1. One<br>2. Two<br>3. Three +Horizontal Rule <br>\--- | Horizontal Rule<br>\*\*\* | Horizontal Rule <br>* * * +\`Inline code\` with backticks | |`Inline code` with backticks +\`\`\`<br>\# code block <br>print '3 backticks or'<br>print 'indent 4 spaces' <br>\`\`\` | ····\# code block<br>····print '3 backticks or'<br>····print 'indent 4 spaces' | \# code block <br>print '3 backticks or'<br>print 'indent 4 spaces' +::: spoiler hidden stuff<br>*a bunch of spoilers here*<br>::: | | <details><summary> hidden stuff </summary><p><em>a bunch of spoilers here</em></p></details> + +[CommonMark Tutorial](https://commonmark.org/help/tutorial/) + |