]>
Commit | Line | Data |
---|---|---|
1 | # Homer docs | |
2 | ||
3 | Live on github pages: [https://bastienwirtz.github.io/homer/](https://bastienwirtz.github.io/homer/) | |
4 | ||
5 | ## Local development | |
6 | ||
7 | ### Install Python dependencies | |
8 | ||
9 | 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. | |
10 | ||
11 | ```sh | |
12 | python -m venv venv | |
13 | source venv/bin/activate | |
14 | pip install -r requirements.txt | |
15 | ``` | |
16 | ||
17 | ### Preview local copy | |
18 | ||
19 | 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. | |
20 | ||
21 | ```sh | |
22 | mkdocs serve | |
23 | ``` | |
24 | ||
25 | Your local version of the docs site will now be available at http://localhost:8000/. |