This template uses MkDocs with the Material theme to create elegant, responsive, and well-structured documentation for your projects.
This repository is a template repository.
You can create your repository by clicking the Use this template
button on the upper right corner.
Before you being, make sure you have the following installed:
- Python (version 3.8 or higher)
- Poetry (recommended)
- or pip
- Clone the repository:
git clone https://github.com/<username>/<repo-name>.git cd <repo-name>
- Install dependencies:
poetry install
- Activate the virtual environment:
poetry shell
- Clone the repository:
git clone https://github.com/<username>/<repo-name>.git cd <repo-name>
- Create and activate a virtual environment:
python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate`
- Install dependencies:
pip install -r requirements.txt
-
Preview the documentation:
mkdocs serve
Your documentation site will be available at
https://localhost:8000/
. -
Build the documentation for deployment:
mkdocs build
The static site will be generated in the
site
directory. -
Deploy to GitHub Pages:
mkdocs gh-deploy
This command will deploy your site to the
gh-pages
branch of your repository and make it available on GitHub Pages.
Configure your documentation by editing the mkdocs.yml
file. This file contains various settings such as theme, extension, and navigation structure. For more information, refer to the Material for MkDocs Documentation
This template is built using the following open-source projects:
- MkDocs: A fast, simple and downright gorgeous static site generator that's geared towards building project documentation.
- Material for MkDocs: A Material Design theme for MkDocs, created by Martin Donath (Squidfunk).
This project is licensed under the MIT License - see the LICENSE file for details.