Add a user guide. Fixes #543

diff --git a/README.md b/README.md
index b55d678fca416a33cf2aa7383f51913b3d3b3809..a18b210b2f4fbc961615d5fefea3bf18e9bc9c78 100644 (file)
--- 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 c2df6223e6d09c618c30fe52e8544c94de0cfba3..0514cbcdaa3c0faf9a3382fe37d9af96db893de1 100644 (file)
--- 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 (file)
index 0000000..426d659
--- /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 | ![Markdown](https://commonmark.org/help/images/favicon.png) 
+\> 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/)
+

diff --git a/ui/src/utils.ts b/ui/src/utils.ts
index 329168d269dd05bd22be22897a9dbaeef47ba684..1d5615abb7a31ad4fb8d62afe283687fa2563cd6 100644 (file)
--- 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;