Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
onelivesleft committed Jan 30, 2021
1 parent 58e0964 commit a727651
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,17 @@ Alternatively, you can make modifications to individual pages then submit them f
If you choose to install MKDocs so you can live-preview your changes, you may do so [by following these instructions](https://squidfunk.github.io/mkdocs-material/getting-started/).

Otherwise, you will not need to install anything to edit the text files.


#### Steps

* Have a working `pipenv`
* In this folder, do `pipenv install`. You might need elevated priviledges.
* `pipenv shell`
* `pip install mkdocs`
* `pip install pymdown-extensions `
* `pip install mkdocs-material==4.6.3`

* `mkdocs build` to build the docs
* `mkdocs serve` to run the docs on a local webserver for testing.
* `mkdocs gh-deploy` to deploy

0 comments on commit a727651

Please sign in to comment.