aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/development.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/development.md')
-rw-r--r--docs/development.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/development.md b/docs/development.md
index a22ae0b..c02406b 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -72,3 +72,32 @@ body #app.theme-my-awesome-theme. { ... }
72... 72...
73@import "./themes/my-awesome-theme.scss"; 73@import "./themes/my-awesome-theme.scss";
74``` 74```
75
76
77## Documentation
78
79### Install Python dependencies
80
81Homer's documentation is built using
82[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). To get
83started, you'll need Python 3 installed on your machine and set up your local
84environment.
85
86```sh
87python -m venv venv
88source venv/bin/activate
89pip install -r requirements.txt
90```
91
92### Preview local copy
93
94MkDocs comes with a command-line utility for building and serving the static
95documentation site every time you save a file. To launch it, run the `serve`
96command.
97
98```sh
99mkdocs serve
100```
101
102Your local version of the docs site will now be available at
103http://localhost:8000/.