diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..45ddf0a --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +site/ diff --git a/README.md b/README.md index 5a15061..b8f2578 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file