From 8c81dc04da15c41deed334916e6e179d583b40b2 Mon Sep 17 00:00:00 2001 From: Dessalines Date: Mon, 17 Feb 2020 20:48:17 -0500 Subject: [PATCH] Add a user guide. Fixes #543 --- README.md | 1 + docs/src/SUMMARY.md | 1 + docs/src/about_guide.md | 28 ++++++++++++++++++++++++++++ ui/src/utils.ts | 2 +- 4 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 docs/src/about_guide.md diff --git a/README.md b/README.md index b55d678fc..a18b210b2 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,7 @@ Each lemmy server can set its own moderation policy; appointing site-wide admins - [Docker](https://dev.lemmy.ml/docs/administration_install_docker.html) - [Ansible](https://dev.lemmy.ml/docs/administration_install_ansible.html) - [Kubernetes](https://dev.lemmy.ml/docs/administration_install_kubernetes.html) + ## Support / Donate Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project. diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index c2df6223e..0514cbcda 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 000000000..426d659a0 --- /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
========= | # Heading 1 +\## Heading 2 | Heading 2
--------- | ## Heading 2 +\[Link\](http://a.com) | \[Link\]\[1\]

\[1\]: http://b.org | [Link](https://commonmark.org/) +!\[Image\](http://url/a.png) | !\[Image\]\[1\]

\[1\]: http://url/b.jpg | ![Markdown](https://commonmark.org/help/images/favicon.png) +\> Blockquote | | > Blockquote +\* List
\* List
\* List | \- List
\- List
\- List
| * List
* List
* List
+1\. One
2\. Two
3\. Three | 1) One
2) Two
3) Three | 1. One
2. Two
3. Three +Horizontal Rule
\--- | Horizontal Rule
\*\*\* | Horizontal Rule
* * * +\`Inline code\` with backticks | |`Inline code` with backticks +\`\`\`
\# code block
print '3 backticks or'
print 'indent 4 spaces'
\`\`\` | ····\# code block
····print '3 backticks or'
····print 'indent 4 spaces' | \# code block
print '3 backticks or'
print 'indent 4 spaces' +::: spoiler hidden stuff
*a bunch of spoilers here*
::: | |
hidden stuff

a bunch of spoilers here

+ +[CommonMark Tutorial](https://commonmark.org/help/tutorial/) + diff --git a/ui/src/utils.ts b/ui/src/utils.ts index 329168d26..1d5615abb 100644 --- a/ui/src/utils.ts +++ b/ui/src/utils.ts @@ -42,7 +42,7 @@ import emojiShortName from 'emoji-short-name'; import Toastify from 'toastify-js'; export const repoUrl = 'https://github.com/dessalines/lemmy'; -export const markdownHelpUrl = 'https://commonmark.org/help/'; +export const markdownHelpUrl = '/docs/about_guide.html'; export const archiveUrl = 'https://archive.is'; export const postRefetchSeconds: number = 60 * 1000;