Skip to main content

Doxicity turns a directory of markdown files into a robust, accessible documentation website. You can configure it, add plugins, and use Handlebars expressions to do amazing things.

It’s fast, free, and flexible.

Designed in New Hampshire by Cory LaViska .

Meet Doxicity

Everyone loves good documentation, but few actually enjoy creating it. Unfortunately, documentation is often one of the last things to land in a project. Sometimes, it’s neglected entirely.

Doxicity removes the friction of creating a documentation website by allowing you to focus on the stuff that matters — content! Using markdown, you can create pages that turn into a robust, accessible documentation website with a single command.

  1. Write markdown ✏️
  2. Add config data, front matter, plugins, and/or expressions ✨
  3. Run npx doxicity and publish your new docs 📗

Doxicity ships with an elegant theme that includes light/dark mode, multiple theme colors, and printer-friendly styles out of the box. Most of its functionality comes from plugins, which are fun to write but incredibly powerful.

Try It

The fastest way to try Doxicity is by running the following commands in your terminal. Installation isn’t required, but you’ll need to have Node.js on your machine.

echo '# Welcome to Doxicity' > index.md
npx doxicity --serve

This will create a single markdown filed called index.md and publish it to _docs/index.html. It will then launch a development server so you can preview your work as you edit. Go ahead and make some changes to index.md and watch the browser instantly update. ✨

If this is your first time using Doxicity, please check out the quick start to see everything you can do!

Notable Features