🔗👋 About Booyaka
Booyaka is a fast, self-hosted, open-source documentation site generatorbuilt with the Nim programming language. It allows you to create beautiful, fast, and easy-to-navigate documentation websites from simple Markdown files.Booyaka is a single-file binary CLI application that is crazily fast, super lightweight, and easy to set up, making it an excellent choice for developers who want to document their projects efficiently.
🔗😍 Key Features
Here are some of the key features that make Booyaka stand out
- 🔥 Compiled, extremely lightweight, super fast and... 🤩 SELF-HOSTED!
- 🌍 Cross-platform CLI application (Linux, macOS, Windows)
- 📄 Generate documentation websites from Markdown files
- 🤔 YAML or JSON based configuration? Choose your favorite! 😻
- ⚡️ Dynamic Site Generation with embedded HTTP server
- 🔎 Search Functionality with Offline capabilities powered by IndexedDB
- 🔁 Browser Sync & Live Reload
- 📲 Responsive & Clean UI 💪 Powered by Bootstrap 5
- 💅 Customizable UI themes
- 🧩 Easy to extend with custom CSS and JS
- 🎩 Open Source | AGPLv3 License
- 👑 Written in Nim language | Made by Humans from OpenPeeps
🔗🚀 Getting Started
To install Booyaka, you can use nimble to build from source. Read the Nim installation guide if you don't have Nim installed.
nimble install booyaka🔗🔁 Live reload
Booyaka supports live reloading of the documentation website when changes are made to the source files. To enable this feature, you can specify a watchPath parameter when starting the server.
🔗🤟 Contributions & Support
- 🐛 Found a bug? Create a new Issue
- 👋 Wanna help? Fork it!
- 😎 Get €20 in cloud credits from Hetzner
🔗🎩 License
Booyaka is licensed under the AGPLv3 License. See the LICENSE file for more information.
