Booyaka! I'm building a fully open-source documentation site generator, as an alternative to cloud-based/closed-source Mintlify or Redocly. So, Booyaka is a modern, good-looking doc site generator that you can self-host and customize as you want, free of charge (never understand why these mofkaz try to get rich from parsing some markdown files 😂 )
For the Markdown parsing, I'm using my own (incomplete) library called Marv, which I'm also developing alongside Booyaka. Marv supports most of the common Markdown syntax, including footnotes, table of contents generation and heading anchors. Also, is perfomant as hell (over 100K lines of markdown text ~5.3 MB in ~188ms on a boring Ryzen 5).
As for the webserver I'm using Supranim (which is also incomplete, but works pretty well! Will tell you more about it in another post), which wraps the libevent library.
Back to Booyaka, the project is not yet open-sourced, but I plan to do it in the next few weeks. Most probably in January!
Meanwhile, here you have a live demo 👉 https://booyaka.openpeeps.dev (on mobile looks creepy!)
The GitHub repo: https://github.com/openpeeps/booyaka
Booyaka Features
- Dynamic doc/book site generation from Markdown files
- Browser Sync & Live Reload
- Search functionality with offline capabilities powered by IndexedDB
- Markdown YAML frontmatter support (title, description, tags)
- Responsive & Clean UI powered by Bootstrap 5
- Unlimited CSS/JS - No credit card required! 😂
- Share page (copy as plain text, md + share to AI chatbots)
- OpenGraph Image generation using pixie and chroma (this should be a separate package!)
- Custom sidebar sections (for ads, banners, custom HTML)
- YAML or JSON based configuration (your choice!)
- NO React, Svelte, Vue, or any FAANG-sh*t frameworks
- Self-hosted & forever free!
Other features that I'm planning to add
- Inline Editor
- Multi-language support
- PDF Export
- OpenAPI/Swagger
I want to make Booyaka run as a single binary with no external dependencies (including static linking of libevent), so it can be easily deployed on any server or even run locally even on non-technical users' machines.
Btw, Nim is amazing! Mamma mia! Haha
If you have any ideas or suggestions, please let me know! Will keep you posted with the progress 🤟
NO React, Svelte, Vue, or any FAANG-sh*t frameworks
Finally documentation that loads and scroll fast! So annoyed by these humongous documentations that need to make you swallow megabytes of JS. Less is more!
Going to try it out for my next project, great work so far!