Prepped the rest of the documentation for launch

[github/bastienwirtz/homer.git] / docs / development.md

diff --git a/docs/development.md b/docs/development.md
index a22ae0b2b6b648a25a5dd8a08ff2ed327d025c04..c02406b3cd521f219e0a4ffef0511658c52e8464 100644 (file)
--- a/docs/development.md
+++ b/docs/development.md
@@ -72,3 +72,32 @@ body #app.theme-my-awesome-theme. { ... }
 ...
 @import "./themes/my-awesome-theme.scss";
 ```
+
+
+## Documentation
+
+### Install Python dependencies
+
+Homer's documentation is built using
+[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). To get
+started, you'll need Python 3 installed on your machine and set up your local
+environment.
+
+```sh
+python -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
+
+### Preview local copy
+
+MkDocs comes with a command-line utility for building and serving the static
+documentation site every time you save a file. To launch it, run the `serve`
+command.
+
+```sh
+mkdocs serve
+```
+
+Your local version of the docs site will now be available at
+http://localhost:8000/.