mergerfs/mkdocs/README.md

# mkdocs

## Getting started

```bash
python3 -m venv venv
source venv/bin/activate
pip3 install --no-cache-dir mkdocs mkdocs-material pymdown-extensions mike
mike serve
```

## Deploy

```bash
mike deploy --push <version_name> --allow-empty
```


## References

* https://www.mkdocs.org/
* https://squidfunk.github.io/mkdocs-material/
add mkdocs Initial commit of a mkdocs based docs setup 2024-12-21 16:36:07 +01:00			`# mkdocs`

			`## Getting started`

			```bash
Rework mkdocs based documentation Lots of restructoring and extra information. 2024-12-23 22:12:26 -06:00			`python3 -m venv venv`
			`source venv/bin/activate`
Add versioning to docs using 'mike' 2025-05-08 19:53:54 -05:00			`pip3 install --no-cache-dir mkdocs mkdocs-material pymdown-extensions mike`
			`mike serve`
add mkdocs Initial commit of a mkdocs based docs setup 2024-12-21 16:36:07 +01:00			```

Misc documentation changes (#1489) 2025-06-29 19:08:57 -05:00			`## Deploy`

			```bash
			`mike deploy --push <version_name> --allow-empty`
			```


add mkdocs Initial commit of a mkdocs based docs setup 2024-12-21 16:36:07 +01:00			`## References`

Rework mkdocs based documentation Lots of restructoring and extra information. 2024-12-23 22:12:26 -06:00			`* https://www.mkdocs.org/`
			`* https://squidfunk.github.io/mkdocs-material/`