About Sloppy Wiki¶
Sloppy Wiki is a template repository designed to help you create beautiful, functional documentation wikis using MkDocs and the Material theme.
Project Goals¶
- 📚 Provide a complete, working wiki template
- 🎓 Teach by example with comprehensive documentation
- 🚀 Make wiki creation accessible to everyone
- 🔧 Showcase best practices for documentation
Why "Sloppy"?¶
The name embraces the philosophy that done is better than perfect. We want to lower the barrier to creating documentation:
- Don't let perfectionism stop you from starting
- Iterate and improve over time
- Focus on content first, polish later
- "Sloppy" today becomes refined tomorrow
Features¶
- ✅ Complete MkDocs + Material theme setup
- ✅ Automated GitHub Pages deployment
- ✅ Helper scripts for common tasks
- ✅ Comprehensive documentation and examples
- ✅ Dark mode support
- ✅ Mobile-responsive design
- ✅ Search functionality
- ✅ Syntax highlighting for 100+ languages
- ✅ Mermaid diagram support
- ✅ Custom styling with CSS
Technology Stack¶
- MkDocs - Static site generator
- Material for MkDocs - Beautiful theme
- PyMdown Extensions - Enhanced Markdown
- GitHub Actions - Automated deployment
- GitHub Pages - Free hosting
License¶
This project is licensed under the Apache License 2.0.
You're free to:
- ✅ Use for commercial projects
- ✅ Modify and customize
- ✅ Distribute
- ✅ Use privately
See LICENSE for full details.
Contributing¶
Contributions are welcome! This template improves when people:
- Report issues
- Suggest features
- Submit pull requests
- Share improvements
Author¶
Created by Pierce
Inspired by the deanpierce.net wiki.
Getting Help¶
- 📖 Read the documentation
- 🐛 Report bugs on GitHub Issues
- 💬 Ask questions in Discussions
Acknowledgments¶
Built with these excellent open-source projects:
Version¶
Current version: 1.0.0
Last updated: October 25, 2025
Start building your wiki today!
Get Started →