wompmacho
56c4f853c0
All checks were successful
deploy-docs / build-and-deploy (push) Successful in 1m11s
27 lines
801 B
Markdown
27 lines
801 B
Markdown
---
|
|
title: mkdocs
|
|
description: static site generator
|
|
showHero: false
|
|
author: wompmacho
|
|
date: '2025-02-04'
|
|
lastmod: '2025-02-04'
|
|
tags: ['documentation', 'mkdocs', 'self-hosted']
|
|
---
|
|
|
|
## What is mkdocs?
|
|
|
|
MkDocs is a fast, simple, and extensible static site generator geared specifically toward building project documentation. It relies heavily on Markdown files, which makes it incredibly accessible for developers who want to write docs as easily as they write code.
|
|
|
|
## Docker Compose Example
|
|
|
|
Running mkdocs with [material](https://squidfunk.github.io/mkdocs-material/)
|
|
theme and plugins built in.
|
|
|
|
> [!INFO]
|
|
> There is some setup of folders and things that are not automatic so
|
|
wont work straight out of the box.
|
|
|
|
```yaml
|
|
{{% include "/srv/configs/docker_compose/mkdocs/docker-compose.yaml" %}}
|
|
```
|