Initialize project with clean ignore rules

This commit is contained in:
2026-03-09 04:08:19 +00:00
commit be6bf12d35
85 changed files with 4285 additions and 0 deletions

View File

@@ -0,0 +1,49 @@
---
title: mkdocs
description: mkdocs
author: wompmacho
date: 2025-02-04
lastmod: 2025-02-04
showHero: false # needed to hide "hero banner"
---
## 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
# mkdocs -- https://squidfunk.github.io/mkdocs-material/
version: '3'
services:
mkdocs:
container_name: 'mkdocs'
restart: unless-stopped
image: squidfunk/mkdocs-material
environment:
- PUID=1000
- PGID=1000
volumes:
#- /mnt/store/app/mkdocs/:/docs
- docs_nfs:/docs
stdin_open: true
tty: true
ports:
- "9896:8000"
volumes:
docs_nfs:
name: docs_nfs
driver_opts:
type: nfs
o: addr=truenas,nolock,soft,ro
device: :/mnt/store/vault/app/mkdocs
```