diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..80c2efce --- /dev/null +++ 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