7 ms·
Show HN: We built a FOSS documentation CMS with a pretty GUI
Kalmia started as a small hobby project about two months ago, but it quickly evolved when we needed a better solution to manage our office's documentation. It has now become our go-to tool for both internal and user-facing docs.
Recently, we decided to open source it, as we believe others might benefit from a lightweight, customizable documentation system like this. We're excited to see how the community can take it further, contribute, and adapt it to their own needs!
- wiradikusuma 2y agoCongrats on launching! Quick question: is this closer to WikiJS (https://js.wiki/ https://js.wiki/), TinaCMS (https://tina.io/ https://tina.io/), Docusaurus (https://docusaurus.io/ https://docusaurus.io/), or something else?
- arch1e 2y agoThank you so much! Great question. Kalmia actually borrows elements from all three, but in different ways: * On the GUI side, it leans heavily towards TinaCMS. We even considered using TinaCMS directly (Tinasaurus (https://github.com/tinacms/tinasaurus https://github.com/tinacms/tinasaurus)) but ultimately built our own for better integration with our backend. * For the backend (MDX -> HTML) generation, it's very similar to Docusaurus. We use a tool called RsPress, which is part of the RsBuild/RsPack tool suite. It's relatively new, but because it's written in Rust, it's much faster than Docusaurus. (Fun fact, if you look at the commit history you will see that we initially used Docusaurus but then migrated away from it!) * Wiki.js is extremely extensive, but it’s dropping support for SQLite, which was a big factor for us. Also, its frontend for documentation doesn’t feel as fast as RsPress (you can try ours out on kalmia.difuse.io it's hosted on single core azure server). The biggest reason we didn’t go with Wiki.js was the versioning system—it felt clunky (or non existent for entire docs?). In Kalmia, versioning the entire documentation is just a one-click process. So, in short, Kalmia combines a TinaCMS-like editing experience with Docusaurus-like static site generation, but with speed advantages from the latest Rust based tooling for SSG.
- zimbatm 2y agoIt looks closer to https://www.getoutline.com/ https://www.getoutline.com/
- arch1e 2y agoI actually just discovered Outline yesterday! It's an awesome platform. Our feature set isn't as extensive (yet), especially when it comes to integrations—they've really nailed that. However, many of the other features, like live collaboration and better security, are things we're actively working on and should be available in the next few releases. One major difference between Outline and Kalmia is the license. I believe Outline uses BSL, while Kalmia is AGPL.
- insane_dreamer 2y agoSlab is another one (we use it, but have no connection to it) https://slab.com/ https://slab.com/ Would be happy to switch to a self-hosted FOSS alternative though.
- buibuibui 2y agoWe self-hosted Outline like two weeks ago in our company (15 people) and the acceptance is overwhelming positive. We tried different tools in the past: WikiJS, XWiki, docuwiki, Bookstack and there was quite a big resistance in using it. Main reasons where like, missing core functions e.g. no live collaboration, no e-mail notifications on commenting, no diagram functions, strange rules regarding page organisation, etc. Outline feels mentally really lightweight but checks all boxes that we searched for. Some people says its quite similar to Notion, but without the automatisation stuff (I have no experience with Notion).
- ravjo 2y agoGood question that led to insightful responses. I would like to bring GitBook (https://gitbook.com https://gitbook.com) too to the comparison notes (no affiliation). They, too, focus on the collaborative, 'similar-to-git-workflow', and versioned approach towards documentation. Happy to see variety in the 'docs' tools area, and really appreciate it being FOSS. Looking forward to trying out Kalmia on some project soon.
- asynchronous 2y agoUsing Rust for markdown parsing seems like the epitome of driving a racecar to the grocery store- I’m curious if you have any metrics as to how much build time was reduced with that over using something like Node. I’d guess it’s <10ms.
- arch1e 2y agoWe saw nearly the same reduction in build times (~80-90%) as quoted in the official RsPress documentation. Keep in mind, we're using MDX, not just plain Markdown. Source: https://rspress.dev/guide/start/introduction#build-performance https://rspress.dev/guide/start/introduction#build-performan...
- liambigelow 2y agoThere can be more of a difference than you might expect. In static site generators, Eleventy is about as fast as you can get in the JavaScript world, and is still 2-3x the time for Hugo in Go [1]. A couple orders of magnitude more than <10ms in this test which is predominantly markdown parsing. Anecdotally, for large or extra large sites, the build performance gap between even Eleventy and Hugo can be quite large. And the gap from either of those to the newer JavaScript tools like Next.js is enormous. 1: https://www.11ty.dev/docs/performance/#build-performance https://www.11ty.dev/docs/performance/#build-performance
- oneseven 2y agoLooks great! Why do you need a database? Seems like that limits the deployment options. You can't deploy to github pages, for example.
- arch1e 2y agoGood point! We use a database (SQLite or Postgres) to enable more advanced features like versioning, collaboration, and access control, which aren't easily managed with static files alone. The database also allows us to scale better for teams with frequent updates. While it does limit deployment to platforms like GitHub Pages, Kalmia is designed for teams that need more than just static documentation—think of it as a middle ground between static site generators and fully dynamic CMS solutions. For purely static sites, there are other great options out there, but Kalmia focuses on more interactive, collaborative documentation. That said, we’re actually interested in providing an option for users to export and deploy it to platforms like GitHub Pages or similar, so stay tuned for future updates on that!
- 9dev 2y agoYou could look into frontmatter to store metadata within the files, and just load it all into memory on startup. Even for huge projects, that probably won’t hurt anyway.
- arch1e 2y agoWe already load all the documentation assets into memory whenever something changes. Even with large projects spanning hundreds of pages and page groups, it remains very fast—under 1 second in our testing. That being said, there are some cases where a database is necessary. For example, handling multiple people editing the same document simultaneously wouldn’t work well with just flat files. Also, where would we store user emails/passwords for authentication? Another feature Kalmia supports is private documentation, where users need to log in to access certain docs (there's a simple toggle to enable authentication). That said, adding an "export to zip" or "push to git" button is totally feasible, and it's something we've had a lot of requests for. While we don't personally use it, we'll be adding it so people can host their docs on static file platforms without needing Kalmia as the backend.
- mattfrommars 2y agoI have yet go understand how people built slick UI like this. Is this Chakra UI? The notification that shows up and bounces a bit, I've seen that on other websites too.
- arch1e 2y agoTailwind! And tailwind based component libraries like flowbite made of all these possible.
- deleted 2y ago[deleted]
- CaptainFever 2y agoIt might be Mantine UI: https://ui.mantine.dev/ https://ui.mantine.dev/
- apsurd 2y agoCSS animations. Here's a drop-in one https://animista.net/play/entrances/bounce-in/bounce-in-right https://animista.net/play/entrances/bounce-in/bounce-in-righ...
- Eduard 2y agois the website dog-fed? first thing I looked for and couldn't find (hence left) was a demo instance
- joekrill 2y agoPretty sure that the site itself (the documentation that is linked to) is built with it.
- arch1e 2y agoThis is accurate, we also use it for one of our other products here https://docs.difuse.io/ https://docs.difuse.io/, although a demo instance for people to play around with is not a bad idea, will look into that.
- papa_frito 2y agoNice framework! I think it's missing a graph view that shows the connections between documents. Something like what Quartz provides. https://quartz.jzhao.xyz/ https://quartz.jzhao.xyz/
- ofrzeta 2y agoI browsed the documentaton a bit and struggle to understand. CMS for me means "web server side application that stores data". However I don't understand how this goes together with "Cross-Platform Compatibility: Run Kalmia virtually anywhere thanks to its Go-based architecture." I couldn't find a roadmap for the project but I would suggest to implement some sort of SSO. At work it was so much easier to justify bringing in a new tool like https://www.getoutline.com/ https://www.getoutline.com/ where we could use OIDC to integrate with Gitlab user management.
- arch1e 2y agoThank you for the feedback! I understand the confusion. Kalmia is indeed a server-side CMS, but its Go-based architecture allows it to be lightweight and run on various platforms, from cloud servers to smaller setups like Raspberry Pi. Think of Kalmia as similar to Docusaurus, but with a built-in GUI—one of the most requested features from the Docusaurus community (https://docusaurus.io/feature-requests/p/make-content-editing-easier https://docusaurus.io/feature-requests/p/make-content-editin...). With Kalmia, non-technical users can contribute to documentation without needing to know Git or Markdown, making content editing much easier. We store the documentation data in a database (Postgres or SQLite), and markdown/HTML is generated only when updates, deletions, or creations happen. The built HTML is stored in memory for fast access, ensuring performance remains smooth even for large docs. We’re also working on features like export to zip and GitHub Pages support, so users can host their docs externally if needed. Regarding SSO, it’s a great suggestion. We’re looking into integrating Single Sign-On (SSO) to streamline user management and improve security. This will help with easier adoption in environments that already use OIDC for authentication. (We already supported OAuth with Github/Microsoft/Google) Thanks again for your thoughtful input, and I appreciate you checking out Kalmia!
- the_arun 2y agoIs there a way to deploy it as github pages?
- arch1e 2y agoWe’re actively working on a feature to support deployment to Git-based repos, including GitHub Pages. Stay tuned!
- amelius 2y agoShould use LLMs to extract documentation from source code.
- nprateem 2y agoI'd like a CMS for static files so non git users can edit my hugo/whatever static sites (marketing, docs, etc). Are there any that just work with markdown and git repos?
- arch1e 2y agoI don’t think there’s an existing tool that handles Markdown and Git repos without requiring users to interact with Git directly. We’re currently developing a feature that allows you to push directly to Git from Kalmia. Instead of pushing Markdown, we’ll push the compiled HTML/JS output, eliminating the need for a build step in the Git repo and making CI/CD processes unnecessary.
- nprateem 2y agoOne of the saas hosting companies made one for Hugo iirc, but it looks like crap and is pretty basic. It's a pretty easily solvable problem but I guess developers are focussing on bigger markets. I'd want to keep the build step since I may pull markdown from other sources like I think astra allows. I really just want to be able to give access to a marketing team to update the blog etc as a nice UI over using markdown and git (which is never going to happen).
- arch1e 2y ago> I'd want to keep the build step since I may pull markdown from other sources like I think astra allows. Pushing without building is not a difficult thing to do, in-fact it will make changes much faster too. But you mention pulling markdown files from other places, merge conflicts are bound to happen that way right? And AFAICS there would not be an easy way to manage that automagically without human intervention.
- nprateem 2y agoNo I think it'd be enough to have them separate to avoid merge conflicts. It could probably be done in a separate step or something so users can edit files once they've been pulled in from other sources, at which point the repo becomes the source of truth.