https://github.com/mathieubesson/mkdocs

My pesonnal wiki build with Mkdocs Material
https://github.com/mathieubesson/mkdocs

documenation markdown mkdocs-material

Last synced: 2 days ago
JSON representation

My pesonnal wiki build with Mkdocs Material

• Host: GitHub
• URL: https://github.com/mathieubesson/mkdocs
• Owner: MathieuBesson
• License: gpl-3.0
• Created: 2024-09-07T14:09:23.000Z (21 days ago)
• Default Branch: main
• Last Pushed: 2024-09-20T13:17:38.000Z (8 days ago)
• Last Synced: 2024-09-26T03:06:33.622Z (2 days ago)
• Topics: documenation, markdown, mkdocs-material
• Language: Dockerfile
• Homepage: https://doc.mathieu-besson.fr
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://img.shields.io/badge/docker-v27-2496ED?logo=docker&logoColor=white&labelColor=2496ED&color=white)

![docker-compose](https://img.shields.io/badge/docker--compose-v1-2496ED?logo=docker&logoColor=white&labelColor=2496ED&color=white)

## Usage

### Development

Run the live-reloading MkDocs server on port 8002:

```bash

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

```

Open [http://localhost:8002](http://localhost:8002) with your browser to see the result.

### Production

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

```bash

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

```

## License

This project is licensed under the GPL License. See the [LICENSE](./LICENSE) file for more details.