Update readme and add gitignore

This commit is contained in:
Ethan Paul 2019-08-27 23:25:50 -04:00
parent a407470ce5
commit bb15a5a222
2 changed files with 48 additions and 2 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
site/

View File

@ -1,3 +1,48 @@
# docs
# omni-docs
ENP.One system and infrastructure documentation, using [MkDocs](https://www.mkdocs.org/)
## Building
1. Install [Pipenv](https://docs.pipenv.org/en/latest/)
```shell
pip install pipenv --user
```
2. Synchronize environment
```shell
pipenv sync
```
3. Build documentation
```shell
pipenv run mkdocs build
```
Built docs are now located in `site/` and can be served as static HTML. See [MkDocs deployment](https://www.mkdocs.org/#deploying)
## Editing/Developing
1. Install [Pipenv](https://docs.pipenv.org/en/latest/)
```shell
pip install pipenv --user
```
2. Synchronize environment, with development dependencies
```shell
pipenv sync --dev
```
3. Run development server
```shell
pipenv run mkdocs serve
```
4. Edit away!
Network documentation