wompmacho
85f2d3a9e0
All checks were successful
deploy-docs / build-and-deploy (push) Successful in 1m6s
27 lines
740 B
Markdown
27 lines
740 B
Markdown
---
|
|
title: mkdocs
|
|
description: mkdocs
|
|
author: wompmacho
|
|
date: 2025-02-04
|
|
lastmod: 2025-02-04
|
|
showHero: false
|
|
tags: []
|
|
---
|
|
|
|
## 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">}}
|
|
```
|