From c8404000156712bd419c67e1cdc776c98021072d Mon Sep 17 00:00:00 2001 From: Wenbo Pan Date: Mon, 19 Aug 2024 17:04:34 +0800 Subject: [PATCH] Add links to documentation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c0190ee..f2259d1 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ moffee automatically adjusts element sizes to accommodate large blocks of text o moffee example PDF

-Or you can use other built-in themes: +Or you can use other built-in [themes](https://moffee.readthedocs.io/en/latest/theme/): @@ -110,7 +110,7 @@ Or you can use other built-in themes: ## Installation -moffee is written in Python and is recommended to install with `pipx`: +moffee is written in Python and is recommended to install with `pipx`. See [our documentation](https://moffee.readthedocs.io/en/latest/installation/) for step-by-step instructions. ```bash pipx install moffee @@ -128,7 +128,7 @@ moffee make example.md -o output_html/ # export to HTML ## Usage -To start, write in standard markdown. moffee supports most extended syntax found in [Obsidian Flavored Markdown](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown). +To start, write in standard markdown. moffee supports most extended syntax found in [Obsidian Flavored Markdown](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown). See [the syntax documentation](https://moffee.readthedocs.io/en/latest/syntax/) for more details. ```markdown # Markdown Title