From 5b27dacf2985eb10b83b5f87ca258e4f4d4c6e5e Mon Sep 17 00:00:00 2001 From: Ethan Paul Date: Tue, 27 Aug 2019 23:32:11 -0400 Subject: [PATCH] Fix formatting errors in readme --- README.md | 56 ++++++++++++++++++++++++------------------------------- 1 file changed, 24 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index b8f2578..c0cf133 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,40 @@ # omni-docs -ENP.One system and infrastructure documentation, using [MkDocs](https://www.mkdocs.org/) +ENP.One system and infrastructure documentation, written using [MkDocs](https://www.mkdocs.org/) -## Building +* [building](#building) +* [editing](#editing) + +## 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 - ``` +```shell +# Install pipenv +pip install pipenv --user +# Synchronize +pipenv sync +# Build docs +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) +The docs are now located in the `site/` directory and can be served as static HTML. See [MkDocs deployment](https://www.mkdocs.org/#deploying) -## Editing/Developing +## editing 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! +```shell +# Install pipenv +pip install pipenv --user +# Synchronize, with dev deps +pipenv sync --dev +# Run dev server +pipenv run mkdocs serve +``` +The development server is available at http://localhost:8000 and will automatically refresh with any changes made to the local files. \ No newline at end of file