Anvilcraft/HexCasting
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update command examples in READMEs

Browse source
This commit is contained in:
object-Object 2023-09-30 02:08:31 -04:00
parent 5755d922e7
commit ce1939644c
2 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/README.md
View file

@ -57,6 +57,11 @@ GITHUB_PAGES_URL=https://gamma-delta.github.io/HexMod
Then run these commands to generate the book: Then run these commands to generate the book:
```sh ```sh
# run from the repo root, not doc/ # run from the repo root, not doc/
hexdoc ./doc/properties.toml -o _site/src/docs hexdoc render doc/properties.toml _site/src/docs
hexdoc_merge --src _site/src/docs --dst _site/dst/docs hexdoc merge --src _site/src/docs --dst _site/dst/docs
```
Or, run this command to render the book and start a local web server:
```sh
hexdoc serve doc/properties.toml --src _site/src/docs --dst _site/dst/docs
``` ```

9
doc/{{cookiecutter.output_directory}}/doc/README.md
View file

@ -37,6 +37,11 @@ GITHUB_PAGES_URL={{ cookiecutter.pages_url }}
Then run these commands to generate the book: Then run these commands to generate the book:
```sh ```sh
# run from the repo root, not doc/ # run from the repo root, not doc/
hexdoc ./doc/properties.toml -o _site/src/docs hexdoc render doc/properties.toml _site/src/docs
hexdoc_merge --src _site/src/docs --dst _site/dst/docs hexdoc merge --src _site/src/docs --dst _site/dst/docs
```
Or, run this command to render the book and start a local web server:
```sh
hexdoc serve doc/properties.toml --src _site/src/docs --dst _site/dst/docs
``` ```