Getting Started

Installation

Docspire can be used on its own, or be installed into an existing project. In both cases, you start with:

npm install docspire -D

Usage

To build your documentation, you can run:

npx docspire

To rebuild your documentation when you change your source files, you can run:

npx docspire --watch

Lastly, to rebuild your documentation when you change your source files and serve it on a local server, you can run:

npx docspire --serve

Configuration

To customize Docspire, you can create a docspire.config.js file in your project root. There are many configuration options to deeply customize your documentation site and its behavior. You can specify them all in a docspire.config.js or in a docspire.config.json file in your project root. To specify a different configuration file, you can use the -c or --config option:

npx docspire -c _build/docspire.config.js