change doc

This commit is contained in:
David Holdeman 2023-01-01 09:27:41 -06:00
parent 90c3635cee
commit d521200450
1 changed files with 2 additions and 2 deletions

View File

@ -33,9 +33,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 the EzLinks plugin, which you can install with `pip install mkdocs-ezlinks-plugin`.
You will also need some plugin, which you can install with `pip install mkdocs-ezlinks-plugin mkdocs-exclude`.
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; rm -r docs site; mkdir docs; cp -r ../!(mkdocs) docs; cp style.css docs; mkdocs build; cd ..`
`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.