Browse Source

Add new README to the `docs` directory.

Kailash Nadh 2 years ago
parent
commit
5d3c10d198
1 changed files with 9 additions and 0 deletions
  1. 9 0
      docs/README.md

+ 9 - 0
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