mirror of
https://github.com/sbrl/Minetest-WorldEditAdditions.git
synced 2024-11-01 05:43:01 +00:00
README: document building the website locally
This commit is contained in:
parent
3e0bed11f0
commit
72ab9e0d64
1 changed files with 16 additions and 0 deletions
16
README.md
16
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))
|
- [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))
|
- [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
|
## Contributing
|
||||||
Contributions are welcome! Please state in your pull request(s) that you release your contribution under the _Mozilla Public License 2.0_.
|
Contributions are welcome! Please state in your pull request(s) that you release your contribution under the _Mozilla Public License 2.0_.
|
||||||
|
|
Loading…
Reference in a new issue