Skip to content

Commit

Permalink
Document deployment to GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
benfrancis authored Jan 10, 2024
1 parent 87779be commit 1b58c26
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,8 @@ To generate a local copy:

You should then be able to access the docs at http://127.0.0.1:8000/ and they will live reload as you edit the markdown files.

See the [MkDocs user guide](https://www.mkdocs.org/user-guide/) for more.
To deploy the documentation to GitHub Pages:

`$ mkdocs gh-deploy`

See the [MkDocs user guide](https://www.mkdocs.org/user-guide/) for more.

0 comments on commit 1b58c26

Please sign in to comment.