diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 3cf74be..f7ef1f7 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -56,6 +56,7 @@ export default defineConfig({ { text: 'What is Lemmy?', link: '/guide/lemmy/overview' }, { text: 'Automation for Lemmy', link: '/guide/lemmy/automation' }, { text: 'Alternative UIs', link: '/guide/lemmy/alternative-uis'}, + { text: 'Lemmy Markdown', link: '/guide/lemmy/markdown' }, { text: 'Securing Lemmy', link: '/guide/lemmy/infrastructure/security', items: [ { text: 'Firewall', link: '/guide/lemmy/infrastructure/firewall' }, { diff --git a/docs/.vitepress/theme/components/ThemedImage.vue b/docs/.vitepress/theme/components/ThemedImage.vue new file mode 100644 index 0000000..267e78a --- /dev/null +++ b/docs/.vitepress/theme/components/ThemedImage.vue @@ -0,0 +1,39 @@ + + + + + + \ No newline at end of file diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index cacfc61..2040834 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -10,6 +10,7 @@ import InfoPill from './components/InfoPill.vue'; import InfoText from './components/InfoText.vue'; import StripeButton from './components/StripeButton.vue'; import DataWrapperChart from './components/DataWrapperChart.vue'; +import ThemedImage from './components/ThemedImage.vue'; export default { extends: DefaultTheme, @@ -26,5 +27,6 @@ export default { app.component('InfoText', InfoText); app.component('StripeButton', StripeButton); app.component('DataWrapperChart', DataWrapperChart); + app.component('ThemedImage', ThemedImage); } } satisfies Theme; diff --git a/docs/guide/lemmy/markdown.md b/docs/guide/lemmy/markdown.md new file mode 100644 index 0000000..ed97674 --- /dev/null +++ b/docs/guide/lemmy/markdown.md @@ -0,0 +1,170 @@ +--- +layout: doc + +head: + - - meta + - property: og:type + content: article + - - meta + - property: og:locale + content: en_CA + - - meta + - property: og:title # max 50-60 characters + content: Guides | Lemmy Markdown + - - meta + - property: og:url + content: https://fedecan.ca/guide/lemmy/markdown + - - meta + - property: og:description # 150-160 characters + content: Lemmy Markdown Guide + - - meta + - property: article:section + content: Guides - Lemmy Markdown +--- + +# Lemmy Markdown + +Lemmy uses markdown-it for rendering markdown. This means that you can use the same markdown syntax that you would use on Lemmy and it follows the [CommonMark spec](https://commonmark.org/). Here are some examples of markdown that you can use on Lemmy: + +## Headers + +```markdown +# Header 1 +## Header 2 +### Header 3 +#### Header 4 +##### Header 5 +###### Header 6 +``` + +Result: + + + + +## Emphasis + +```markdown +*italic* +**bold** +***bold italic*** +~~strikethrough~~ +``` + +Result: + + + + +## Lists + +```markdown +- Unordered list item 1 +- Unordered list item 2 + - Unordered list item 2.1 + - Unordered list item 2.2 +- Unordered list item 3 + +1. Ordered list item 1 +2. Ordered list item 2 +3. Ordered list item 3 +``` + +Result: + + + + + +## Links / Images + +```markdown +[Link text](https://example.com) +![Image Alt](https://example.com/image.jpg "Image title") +![The fedecan Logo](https://fedecan.ca/img/icons/maple-leaf.svg "Maple Leaf") +``` + +Result: + + + + +## Blockquotes + +```markdown +> Block +> -quote +``` + +Result: + + + + +## Code + +````markdown +`inline code` + +```python +def hello(): + print("Hello, World!") +``` +```` + +Result: + + + + +## Tables + +> Tables are not officially documented. + +```markdown +| Header 1 | Header 2 | Header 3 | +|----------|----------|----------| +| Row 1 | Row 1 | Row 1 | +| Row 2 | Row 2 | Row 2 | +| Row 3 | Row 3 | Row 3 | +``` + +Result: + + + +## Horizontal Rule + +```markdown +--- +``` + +Result: + + + + +## Spoilers + +```markdown +::: spoiler Spoiler Name +Spoiler Content +::: +``` + +Result: + + + +> Note: In the example above, the spoiler is in the open state, by default it is in the closed state. + +## Sub/Superscript + +```markdown +H~2~O +H^2^O +``` + +Result: + + \ No newline at end of file diff --git a/docs/public/img/guides/markdown/blockquotes_dark.png b/docs/public/img/guides/markdown/blockquotes_dark.png new file mode 100644 index 0000000..be8e862 Binary files /dev/null and b/docs/public/img/guides/markdown/blockquotes_dark.png differ diff --git a/docs/public/img/guides/markdown/blockquotes_light.png b/docs/public/img/guides/markdown/blockquotes_light.png new file mode 100644 index 0000000..089a051 Binary files /dev/null and b/docs/public/img/guides/markdown/blockquotes_light.png differ diff --git a/docs/public/img/guides/markdown/code_dark.png b/docs/public/img/guides/markdown/code_dark.png new file mode 100644 index 0000000..44f5e8d Binary files /dev/null and b/docs/public/img/guides/markdown/code_dark.png differ diff --git a/docs/public/img/guides/markdown/code_light.png b/docs/public/img/guides/markdown/code_light.png new file mode 100644 index 0000000..27afc77 Binary files /dev/null and b/docs/public/img/guides/markdown/code_light.png differ diff --git a/docs/public/img/guides/markdown/emphasis_dark.png b/docs/public/img/guides/markdown/emphasis_dark.png new file mode 100644 index 0000000..cd85b31 Binary files /dev/null and b/docs/public/img/guides/markdown/emphasis_dark.png differ diff --git a/docs/public/img/guides/markdown/emphasis_light.png b/docs/public/img/guides/markdown/emphasis_light.png new file mode 100644 index 0000000..bc210e9 Binary files /dev/null and b/docs/public/img/guides/markdown/emphasis_light.png differ diff --git a/docs/public/img/guides/markdown/headers_dark.png b/docs/public/img/guides/markdown/headers_dark.png new file mode 100644 index 0000000..ebe43c3 Binary files /dev/null and b/docs/public/img/guides/markdown/headers_dark.png differ diff --git a/docs/public/img/guides/markdown/headers_light.png b/docs/public/img/guides/markdown/headers_light.png new file mode 100644 index 0000000..a468bd3 Binary files /dev/null and b/docs/public/img/guides/markdown/headers_light.png differ diff --git a/docs/public/img/guides/markdown/horizontal_rule_dark.png b/docs/public/img/guides/markdown/horizontal_rule_dark.png new file mode 100644 index 0000000..6ad4d94 Binary files /dev/null and b/docs/public/img/guides/markdown/horizontal_rule_dark.png differ diff --git a/docs/public/img/guides/markdown/horizontal_rule_light.png b/docs/public/img/guides/markdown/horizontal_rule_light.png new file mode 100644 index 0000000..da2fd81 Binary files /dev/null and b/docs/public/img/guides/markdown/horizontal_rule_light.png differ diff --git a/docs/public/img/guides/markdown/links_images_dark.png b/docs/public/img/guides/markdown/links_images_dark.png new file mode 100644 index 0000000..1abbb7d Binary files /dev/null and b/docs/public/img/guides/markdown/links_images_dark.png differ diff --git a/docs/public/img/guides/markdown/links_images_light.png b/docs/public/img/guides/markdown/links_images_light.png new file mode 100644 index 0000000..a018576 Binary files /dev/null and b/docs/public/img/guides/markdown/links_images_light.png differ diff --git a/docs/public/img/guides/markdown/lists_dark.png b/docs/public/img/guides/markdown/lists_dark.png new file mode 100644 index 0000000..29f8970 Binary files /dev/null and b/docs/public/img/guides/markdown/lists_dark.png differ diff --git a/docs/public/img/guides/markdown/lists_light.png b/docs/public/img/guides/markdown/lists_light.png new file mode 100644 index 0000000..0a6c717 Binary files /dev/null and b/docs/public/img/guides/markdown/lists_light.png differ diff --git a/docs/public/img/guides/markdown/spoilers_dark.png b/docs/public/img/guides/markdown/spoilers_dark.png new file mode 100644 index 0000000..c4c9dc2 Binary files /dev/null and b/docs/public/img/guides/markdown/spoilers_dark.png differ diff --git a/docs/public/img/guides/markdown/spoilers_light.png b/docs/public/img/guides/markdown/spoilers_light.png new file mode 100644 index 0000000..a751d40 Binary files /dev/null and b/docs/public/img/guides/markdown/spoilers_light.png differ diff --git a/docs/public/img/guides/markdown/sub_superscript_dark.png b/docs/public/img/guides/markdown/sub_superscript_dark.png new file mode 100644 index 0000000..f18957a Binary files /dev/null and b/docs/public/img/guides/markdown/sub_superscript_dark.png differ diff --git a/docs/public/img/guides/markdown/sub_superscript_light.png b/docs/public/img/guides/markdown/sub_superscript_light.png new file mode 100644 index 0000000..948428b Binary files /dev/null and b/docs/public/img/guides/markdown/sub_superscript_light.png differ diff --git a/docs/public/img/guides/markdown/tables_dark.png b/docs/public/img/guides/markdown/tables_dark.png new file mode 100644 index 0000000..496335b Binary files /dev/null and b/docs/public/img/guides/markdown/tables_dark.png differ diff --git a/docs/public/img/guides/markdown/tables_light.png b/docs/public/img/guides/markdown/tables_light.png new file mode 100644 index 0000000..1633da6 Binary files /dev/null and b/docs/public/img/guides/markdown/tables_light.png differ