Skip to main content

Doxicity is a static site generator that turns markdown files into an HTML website. You can configure it, add data, layouts, partials, plugins, and use Handlebars {{expressions}} to do amazing things.

It’s fast, free, and flexible.

Designed in New Hampshire by Cory LaViska .

Introducing 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 was built to solve this problem, but its uses aren’t limited to just documentation. As a static site generator, you can use Doxicity to power entire websites if you want!

Doxicity focuses on authorship, extensibility, and simplicity.

  1. Pages are written in markdown and can contain optional front matter
  2. Additional data, plugins, helpers, and more are provided through a simple config
  3. Handlebars {{expressions}} can be used to render data
  4. Layouts are just HTML files with optional Handlebars expressions
  5. Doxicity’s programmatic API lets you easily integrate it with your build pipeline

Bonus features include a simple yet robust plugin API and a number of first-party plugins (including search) to help you write better docs.

Quick Start

Installation:

npm i doxicity

Usage:

import Doxicity from 'doxicity';

const __dirname = new URL('.', import.meta.url).pathname;

// Configure it
const dox = new Doxicity({
  source: Doxicity.resolve(__dirname),
  destination: Doxicity.resolve(__dirname, '_site'),
  baseUrl: 'https://example.com/'
  // more options here...
});

// Publish it
dox.publish().catch(err => {
  console.log(err.message);
});

This only shows the bare minimum you need to get started with Doxicity. Please see the getting started guide to learn how to add data, plugins, helpers, and more.