Add new README to the docs directory.

Cf1097 · Mar 26, 2023 · 5d3c10d · 5d3c10d
1 parent 684c15a
commit 5d3c10d
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,9 @@
+# Static website and docs
+
+This repository contains the source for the static website https://listmonk.app
+
+- The website is in `site` and is built with hugo (run `hugo serve` inside `site` to preview).
+
+- Documentation is in `docs` and is built with mkdocs (inside `docs`, run `mkdocs serve` to preview after running `pip install -r requirements.txt`)
+
+- `i18n` directory has the static UI for i18n translations: https://listmonk.app/i18n