Table of Contents

• Quick Start
• Features
• Installation
• Acknowledgments
• License
• Contact

Quick Start

# Clone the repository
git clone https://github.com/feeeedox/simplewiki.git
# Navigate to project directorycd simplewiki
# Install dependencies
bun install
# Start the development server
bun dev

Features

• 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

Installation

To install SimpleWiki, check out the installation guide for detailed instructions.

Acknowledgments

Contributors

Assets & Icons Credits

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.

Inspiration

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

Support the Project

If you like the project, give it a star on GitHub or support the development:

Security

Reporting Security Vulnerabilities

If you discover a security vulnerability, please send an email to f3dox@proton.me. All security vulnerabilities will be promptly addressed.

License

This project is licensed under the MIT License, see the LICENSE file for details.

Contact

Project Maintainer

Florian - @feeeedox

Get in Touch

Project Links

• Documentation: feeeedox.github.io/simplewiki/getting-started/installation
• Demo: feeeedox.github.io/simplewiki
• Issues: GitHub Issues
• Discussions: GitHub Discussions

---

⬆ Back to Top

Made with ❤ by Florian