Documentation

Learn how to use Doc Release to streamline your documentation workflow.

Quick Start

Get up and running with Doc Release in under 5 minutes.

Terminal

# Install the CLI
npm install -g @docrelease/cli

# Initialize in your project
docrelease init

# Generate your first changelog
docrelease changelog generate

Installation

Install Doc Release using your preferred package manager.

npm

npm install @docrelease/cli

yarn

yarn add @docrelease/cli

pnpm

pnpm add @docrelease/cli

Homebrew

brew install docrelease

Changelogs

Automatically generate changelogs from your Git history.

Configuration Example

changelog:
  format: "keep-a-changelog"
  categories:
    - "feat": "Features"
    - "fix": "Bug Fixes"
    - "perf": "Performance"
  includeLinks: true

REST API

Integrate Doc Release into your existing workflows via our REST API.

GET /api/v1/projects/:id/changelog

Retrieve the changelog for a specific project.

Need Help?

Join our community or contact support for assistance.

Contact Support Join Discord