Last Updated: November 21, 2025
MkDocs
Static site generator for documentation
Core Features
| Item | Description |
|---|---|
Markdown
|
Write in Markdown |
Themes
|
Material theme popular |
Plugins
|
Extend functionality |
Navigation
|
Auto-generated sidebar |
Search
|
Built-in search |
Deploy
|
Easy hosting |
Common Commands
| Item | Description |
|---|---|
mkdocs new myproject
|
Create project |
mkdocs serve
|
Development server |
mkdocs build
|
Generate static site |
mkdocs gh-deploy
|
Deploy to GitHub Pages |
Best Practices
- Use Material theme for modern design
- Organize with nav in mkdocs.yml
- Add plugins for features
- Use admonitions for notes/warnings
💡 Pro Tips
Quick Reference
MkDocs is simple and powerful for Python projects