docs/README.md

40 lines
973 B
Markdown
Raw Normal View History

2019-08-28 03:25:50 +00:00
# omni-docs
2019-08-28 03:32:11 +00:00
ENP.One system and infrastructure documentation, written using [MkDocs](https://www.mkdocs.org/)
2019-08-28 03:25:50 +00:00
2019-08-28 03:32:11 +00:00
* [building](#building)
* [editing](#editing)
2019-08-28 03:25:50 +00:00
2019-08-28 03:32:11 +00:00
## building
2019-08-28 03:25:50 +00:00
2019-08-28 03:32:11 +00:00
1. Install [Pipenv](https://docs.pipenv.org/en/latest/)
2019-08-28 03:25:50 +00:00
2. Synchronize environment
3. Build documentation
2019-08-28 03:32:11 +00:00
```shell
# Install pipenv
pip install pipenv --user
# Synchronize
pipenv sync
# Build docs
pipenv run mkdocs build
```
2019-08-28 03:25:50 +00:00
2019-08-28 03:32:11 +00:00
The docs are now located in the `site/` directory and can be served as static HTML. See [MkDocs deployment](https://www.mkdocs.org/#deploying)
2019-08-28 03:25:50 +00:00
2019-08-28 03:32:11 +00:00
## editing
2019-08-28 03:25:50 +00:00
1. Install [Pipenv](https://docs.pipenv.org/en/latest/)
2. Synchronize environment, with development dependencies
3. Run development server
2019-08-28 03:32:11 +00:00
```shell
# Install pipenv
pip install pipenv --user
# Synchronize, with dev deps
pipenv sync --dev
# Run dev server
pipenv run mkdocs serve
```
2018-11-27 03:41:57 +00:00
2019-08-28 03:32:11 +00:00
The development server is available at http://localhost:8000 and will automatically refresh with any changes made to the local files.