Introduction
Osmosis is a framework for building beautiful documentation websites powered by AdonisJS and OsmosJS.
- 📝 MDX Support - Write documentation with JSX components in Markdown
- 🎨 Syntax Highlighting - Beautiful code blocks with Shiki
- 📦 Multiple Sources - Load docs from file system or GitHub repositories
- 🚀 Static Site Generation - Export to static HTML for easy hosting
- 🎯 GitHub Flavored Markdown - Compatible with GFM syntax
- ⚡ Customizable - Extend with remark and rehype plugins
Comparison
Fumadocs
Fumadocs is a React documentation framework with a modern design and customizable.
Osmosis is heavily inspired from Fumadocs and you will find a lot of similarities between the two frameworks. The big difference is that Osmosis uses OsmosJS (instead of React) and AdonisJS (instead of NextJS).
If your documentation is already built on Fumadocs there is no real reasons to migrate as it is more a matter of preferences.
Dimer
Dimer is a documentation framework built by the the author of AdonisJS and it runs the Official AdonisJS documentation website. It uses EdgeJS as the templating engine with basic Markdown support.
As Osmosis is built using OsmosJS it delivers more advanced Markdown features thanks to MDX and a better developer experience.
Osmosis is a great replacement as it is also built on AdonisJS.