Commit 0709ecb4 authored by Abhas Abhinav's avatar Abhas Abhinav

Fixed monospace formatting errors

parent 80848206
......@@ -25,7 +25,7 @@ locally, you need to have python install on your system. Additionally, you need
### Install `mkdocs` and related plugins
Once you have both Python and `python-pip` installed, you can install mkdocs
using the following commands. Additionaly, we use the `material` theme for
using the following commands. Additionaly, we use the Material theme for
mkdocs. Running the following command installs both mkdocs as well as the
corresponding theme:
......@@ -33,25 +33,23 @@ corresponding theme:
$ pip install mkdocs-material
```
You can more details about this on the mkdocs-material home page:
https://squidfunk.github.io/mkdocs-material/
You can more details about this on the mkdocs-material home page: https://squidfunk.github.io/mkdocs-material/
### Run a local webserver
You compile the documentation from the source code as follows:
``` bash
mkdocs build
$ mkdocs build
```
This will generate the static HTML documentation into the `#bash site/`
This will generate the static HTML documentation into the `site/`
directory.
You can also view the documentation using the in-built webserver by running the
following cammdn:
``` bash
```
$ mkdocs serve
INFO - Cleaning site directory
[I 171121 15:24:50 server:283] Serving on http://127.0.0.1:8000
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment