update docs to use scripts
This commit is contained in:
parent
749a4eafaa
commit
52c00dd005
|
@ -32,10 +32,9 @@ You need to set up an access token in your repository secrets for Actions.
|
|||
|
||||
The easiest way to test Wiki3 is locally. You could also set up a webserver and your repository secrets to let the workflow upload it for you, but here I'll just explain how to test locally.
|
||||
|
||||
The full instructions for installing MkDocs can be found [here](https://www.mkdocs.org/user-guide/installation/), but the short version is to run `pip install mkdocs`.
|
||||
You will also need some plugin, which you can install with `pip install mkdocs-ezlinks-plugin mkdocs-exclude`.
|
||||
The full instructions for installing MkDocs can be found [here](https://www.mkdocs.org/user-guide/installation/), but there is also a script included in the repo that will install it for you.
|
||||
Run `bash ./bin/mkdocs-install.sh` if you have a Debian/apt-based system. If not, read the script to find which python packages you need to install.
|
||||
|
||||
Once MkDocs is installed, you can now generate the site.
|
||||
I do this with a one-liner, run from the root directory of the repo:
|
||||
`cd mkdocs; ln -s .. docs; cp style.css ..; mkdocs build; cd ..; rm style.css`
|
||||
MkDocs expects the Markdown documentation files to be in a "docs" subdirectory, so we create it and move everything to it, and then we can go ahead and build the site.
|
||||
There is a script included to do this as well.
|
||||
Run `bash ./bin/mkdocs-run.sh`, and the site files will then be found at ./mkdocs/site
|
||||
|
|
Loading…
Reference in New Issue