MkDocs Material Template (Cookiecutter)

This is a cookiecutter template for documentation projects using MkDocs Material.

✨ Features

• Cookiecutter
• MkDocs Material
• Wiki/Knowledge base
• Technical blog
• Markdown support
• Static site generator
• Project Structure
• Boilerplate/Template
• Best Practices
• Configuration
• Documentation
• Scripts
• CI/CD

---

🐤 Getting started

1. 🚧 Prerequisites

• Install Python (>= v3.10) and pip (>= 23):
  • [RECOMMENDED] Miniconda (v3)
  • [arm64/aarch64] Miniforge (v3)
  • [Python virutal environment] venv

For DEVELOPMENT environment:

• Install git
• Setup an SSH key

2. 📥 Download or clone the repository

2.1. Prepare projects directory (if not exists):

# Create projects directory:
mkdir -pv ~/workspaces/projects

# Enter into projects directory:
cd ~/workspaces/projects

2.2. Follow one of the below options [A], [B] or [C]:

OPTION A. Clone the repository:

git clone https://github.com/[OWNER]/docs-mkdocs-template.git && \
    cd docs-mkdocs-template && \
    git checkout cookiecutter

OPTION B. Clone the repository (for DEVELOPMENT: git + ssh key):

git clone git@github.com:[OWNER]/docs-mkdocs-template.git && \
    cd docs-mkdocs-template && \
    git checkout cookiecutter

OPTION C. Download source code from cookiecutter branch.

3. 📦 Install cookiecutter

# Install cookiecutter:
pip install -U cookiecutter
# Or:
pip install -r ./requirements.txt

4. 🏗️ Generate project with cookiecutter

# Generate project:
cookiecutter -f .
# Or:
./scripts/build.sh

5. 🏁 Start the project

cd [PROJECT_NAME]
# For example:
cd docs-mkdocs-template

👍

---

📑 References

• Cookiecutter (GitHub) - https://github.com/cookiecutter/cookiecutter
• Cookiecutter (Docs) - https://cookiecutter.readthedocs.io/en/stable