SimpleWiki is a file-based documentation engine designed for creating fast and customizable wiki systems.
It transforms Markdown files into a searchable and high-performance documentation platform while keeping the content simple and developer-friendly.
# Clone the repository
git clone https://github.com/feeeedox/simplewiki.git
# Navigate to project directory
cd simplewiki
# Install dependencies
bun install
# Start the development server
bun dev- Fast static site generation
- Markdown and MDC support
- File-based content management
- Automatic navigation generation
- Tailwind CSS powered design
- Custom Vue component support
- Built for documentation and knowledge bases
To install SimpleWiki, check out the installation guide for detailed instructions.
To match the authentic, classic Wiki aesthetics, this project uses a curated collection of classic skeuomorphic and photorealistic web icons:
- Oxygen Icons – Used for some icons, glossy 3D look. Licensed under the LGPL.
This project was inspired by:
- MediaWiki - For the design and structure
- DokuWiki - For the simplicity and file-based approach
- MkDocs - For the static site generation and Markdown support
If you like the project, there are several ways you can support it:
Give the project a star on GitHub!
- Share on social media
- Write a blog post
- Tell your friends and colleagues
If you discover a security vulnerability, please send an email to f3dox@proton.me. All security vulnerabilities will be promptly addressed.
This project is licensed under the MIT License—see the LICENSE file for details.
Florian - @feeeedox
- Documentation: feeeedox.github.io/simplewiki/getting-started/installation
- Demo: feeeedox.github.io/simplewiki
- Issues: GitHub Issues
- Discussions: GitHub Discussions