Commit 2f040aa
committed
Documentation hosting on Github Pages (#11)
Before this PR, the only way to access the documentation was by browsing through the repository's markdown files.
Using the mkdocs framework, an alternative way was created to view documentation as a website.
This patch contains:
- Mkdocs config file `mkdocs.yml`.
- Small corrections in .md files for more correct rendering on the website.
- Custom hooks before site build to ensure .md file links remain
accurate in both the website and repository versions of the docs.
- CI workflow to deploy the documentation site to GitHub Pages.
To check how the site looks locally, you need to:
```
make doc
```
Open documentation on http://localhost:8000/
Important:
- In the repository settings, set the Github Actions source for Github Pages.
Settings -> Pages -> Build and deployment: "GitHub Actions"
- The documentation is deployed in the `github-pages` environment.
You can set up rules for each environment (for example, a timer for deferred deployment)
Settings -> Environment -> [env-name]
Co-authored-by: Vladimir Severov <hackallcode@users.noreply.github.com>1 parent 897ffa0 commit 2f040aa
1 file changed
+1
-7
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
| 30 | + | |
37 | 31 | | |
38 | 32 | | |
39 | 33 | | |
| |||
0 commit comments