docs/README.md

32 lines
849 B
Markdown
Raw Normal View History

2023-06-11 02:51:16 +00:00
# docs
It is a documentation repository for the projects of [InsanusMokrassar](https://github.com/InsanusMokrassar).
2023-06-11 02:51:16 +00:00
## Running locally
2023-06-11 02:51:16 +00:00
2023-09-05 09:25:32 +00:00
### Install poetry
For the ease of dependencies management, this repository uses [Poetry](https://python-poetry.org), a Python project & dependencies manager.
In case you wish to interact with these docs locally, make sure to [install](https://python-poetry.org/docs/#installation) it first.
2023-06-11 02:51:16 +00:00
2023-09-05 09:25:32 +00:00
### Install dependencies
```bash
poetry install --no-root
```
### Build and run
In `Fleet` you may use [these configs](https://github.com/InsanusMokrassar/docs/blob/master/.fleet/run.json) to work with the repo.
2023-06-11 02:51:16 +00:00
To build or run it in vanilla terminal, use the following commands:
2023-06-11 02:51:16 +00:00
```bash
poetry run mkdocs build # Just build the site
2023-06-11 02:51:16 +00:00
```
```bash
poetry run mkdocs serve # Run a local server with the site
2023-06-11 02:51:16 +00:00
```