Doctave: a batteries-included docs site generator
A CLI Tool - Convert Docusaurus ".md" format to Quarto's ".qmd" format
Docusaurus 3.0 - React Static Site Generator for docs sites - by Meta
Rustdoc should support GitHub's note/warning blockquote syntax - tools and infrastructure - Rust Internals
Hi folks,
I posted this on the Rust users forum quite a while ago but thought I'd finally submit this to the Reddit crowd too.
Doctave is a documentation site generator, written in Rust, that builds docs sites from Markdown. It's batteries-included, and hence requires minimal configuration or fiddling with plugins. The goal was to make a tool where you just start writing with minimal effort.
Features out of the box:
-
Mermaid.js diagram support
-
Offline full-text search
-
Local live-reloading server
-
Responsive design
-
Dark mode
-
GitHub flavored markdown
Here's a quick preview to give an idea of what it looks like:
The tool's docs are of course self-hostedYou can deploy the sites on any hosting provider of your choice, such as GitHub pages. I'm also in the process of building a specialized hosting provider for Doctave sites, Doctave.com, for those users who have multiple projects and require some features aimed at larger teams and managing larger documentation projects.
Links:
-
Source: https://github.com/Doctave/doctave
-
Docs (self-hosted, obviously): https://cli.doctave.com/
Would love to hear an feedback you folks may have!
Hi r/rust!
I built my first production Rust CLI and wanted to share.
What it does: Converts Docusaurus markdown files to Quarto format
Why I built it: Needed to migrate 15+ documentation files and couldn't find an automation tool
Tech stack:
-
clap for CLI args
-
regex for pattern matching
-
indicatif for progress bars
-
walkdir for directory traversal
-
GitHub Actions for cross-platform releases
What I learned:
-
Rust's ownership concepts
-
Publishing to crates.io
-
Creating Homebrew formulae
-
Cross-compilation for different architectures
Installation:
cargo install doc2quarto
Links:
-
GitHub: https://github.com/rvbug/doc2quarto
-
Blog: https://qubitai.in/qscribe-docs/posts/Quarto/quarto.html
Feedback welcome! This is my first Rust project.
Hey there 👋 I'm the maintainer of Docusaurus and we just published a new major release, I hope you'll like it!