GitHunt
MA

My pesonnal wiki build with Mkdocs Material

Mkdocs Material wiki

Description

This project provides a Docker-based setup for generating and serving documentation using MkDocs and the Material for MkDocs theme. It supports two environments: development and production.

Prerequisites

docker
docker-compose

Usage

Development

Run the live-reloading MkDocs server on port 8002:

docker-compose -f docker-compose.dev.yml up --build

Open http://localhost:8002 with your browser to see the result.

Production

Generate the static HTML documentation in the /var/www/mkdocs directory:

docker-compose -f docker-compose.prod.yml up --build

License

This project is licensed under the GPL License. See the LICENSE file for more details.

Languages

HTML75.4%Dockerfile24.6%

Contributors

GNU General Public License v3.0
Created September 7, 2024
Updated October 8, 2024
MathieuBesson/mkdocs | GitHunt