https://github.com/humblebeeai/docs-mkdocs-template
This is a template repository for documentation, wiki, knowledge base and technical blog using "Material for MkDocs".
https://github.com/humblebeeai/docs-mkdocs-template
blog docs documentation markdown mkdocs mkdocs-material python software-engineering ssg static-site-generator wiki
Last synced: about 2 months ago
JSON representation
This is a template repository for documentation, wiki, knowledge base and technical blog using "Material for MkDocs".
- Host: GitHub
- URL: https://github.com/humblebeeai/docs-mkdocs-template
- Owner: humblebeeai
- License: mit
- Created: 2024-12-29T07:41:21.000Z (over 1 year ago)
- Default Branch: cookiecutter
- Last Pushed: 2026-03-12T05:24:15.000Z (3 months ago)
- Last Synced: 2026-03-12T11:41:37.307Z (3 months ago)
- Topics: blog, docs, documentation, markdown, mkdocs, mkdocs-material, python, software-engineering, ssg, static-site-generator, wiki
- Language: Shell
- Homepage:
- Size: 1000 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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)](https://www.anaconda.com/docs/getting-started/miniconda/install)**
- *[arm64/aarch64] [Miniforge (v3)](https://github.com/conda-forge/miniforge)*
- *[Python virtual environment] [venv](https://docs.python.org/3/library/venv.html)*
For **DEVELOPMENT** environment:
- Install [**git**](https://git-scm.com/downloads)
- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
### 2. 📥 Download or clone the repository
```sh
# Create projects directory:
mkdir -pv ~/workspaces/projects
# Enter into projects directory:
cd ~/workspaces/projects
# Clone the repository:
git clone [REPOSITORY_URL]
# Or download and extract the repository from GitHub:
# 1. Go to the repository on GitHub.
# 2. Click on the "Code" button.
# 3. Select "Download ZIP" and save the file to your computer.
# 4. Extract the ZIP file in current directory.
# Enter into the repository:
cd docs-mkdocs-template
# Change to cookiecutter branch:
git checkout cookiecutter
```
### 3. 📦 Install cookiecutter
```bash
# Install cookiecutter:
pip install -r ./requirements.txt
# Install pre-commit hooks:
pre-commit install
```
### 4. 🏗️ Generate project with cookiecutter
```bash
# Generate project:
cookiecutter -f .
# Or:
./scripts/build.sh
```
### 5. 🏁 Start the project
```bash
cd [PROJECT_NAME]
```
👍
---
## 📑 References
- Cookiecutter (GitHub) -
- Cookiecutter (Docs) -