From 72ab9e0d64686d376d63b7c60823954c7b6684df Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Mon, 7 Oct 2024 20:41:56 +0100 Subject: [PATCH] README: document building the website locally --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 1cc24af..56f1244 100644 --- a/README.md +++ b/README.md @@ -208,6 +208,22 @@ As linked above: - [Interactive Chat Command Reference](https://worldeditadditions.mooncarrot.space/Reference/) ([git](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md)) - [Lua API Reference](https://worldeditadditions.mooncarrot.space/api/) (built with [moondoc](https://github.com/sbrl/moondoc)) +#### Building the website +The website that contains both of the above can be generated like so. + +First, clone this git repository: + +```bash +git clone git@git.github.com:sbrl/Minetest-WorldEditAdditions worldeditadditions; +cd worldeditadditions/.docs; # cd into the docs folder +``` + +Then, build the docs: + +```bash +npm install +npm run build +``` ## Contributing Contributions are welcome! Please state in your pull request(s) that you release your contribution under the _Mozilla Public License 2.0_.