Docspire

Think about your product, not its docs. A hands-off documentation generator, based on 11ty.

Features

These are all automatically generated and configurable.

• Navigation
  • Site-wide navigation
  • Page contents
  • Heading anchors
  • Breadcrumbs
  • Next/previous page
  • Searchable index pages
• Site-wide search
• Syntax highlighting and copyable code snippets
• Edit on GitHub link
• Callouts

Limitations

Docspire bundles everything you may need, so you only need to worry about the following if you're integrating it into an existing configuration.

• Only compatible with 11ty v3.0.0 and above
• Uses NJK templates, so needs that to be enabled.

Usage

Creating a blank docs site

If you want to create a new docs site, just run the following command:

npm create docspire

This will create a new directory with the following structure:

_build
_layouts/
_templates/
assets/
docs/
package.json
.gitignore

Integrating into an existing site

On an existing site, you can run npm install docspire -D (make sure to run npm init first if you haven’t already). This will install docspire as a dev dependency. You can then use npx docspire (see below) to add templates and config to your site.

If you don't want to use any templates, you can also just use it as an 11ty plugin:

import Docspire from "docspire";

export default function  (eleventyConfig) {
	eleventyConfig.addPlugin(Docspire, {
		/* options */
	});
}

Updating Docspire

Over time, you may want to update Docspire to the latest version. If all you need to do is update 11ty and its plugins, a regular npm update docspire will do. To update the templates (or to copy them over the first time), you can run npx docspire. If any of these files are already present and NOT gitignored, they will not be copied. This gives you a way to customize some of the files if you want to: simply remove them from your gitignore and edit them to your heart's content.