Overview

I use MkDocs to manage and generate documentation for fabien-renaud-fr organization. MkDocs is a simple, static site generator specifically designed for project documentation. It uses Markdown files to create well-structured, easy-to-navigate documentation websites.

Project layout

This repository follows this layout:

mkdocs.yml     # The configuration file
docs/
    index.md   # The documentation homepage
    ...        # Other markdown pages, images and other files
site/          # Unversionned directory containing website statics build 
    index.html # The website homepage
    ...        # Other statics files

Workflow

To publish new content, follows this workflow:

1. Write your content in Markdown files within the docs/ directory
2. Commit and push your changes. The GitHub workflow will automatically run the mkdocs gh-deploy command to generate the site/ directory and publish it on GitHub pages

References

• Wiki / MkDocs / Initialize a new wiki
• (External) MkDocs / Getting Started with MkDocs