Doctave

Doctave is a documentation platform that combines the flexibility of writing in Markdown with the power of professional documentation hosting. You write your documentation in plain text files, store them in Git alongside your code, and Doctave takes care of turning them into beautiful, searchable documentation websites.

The platform supports both regular Markdown guides and OpenAPI specifications for API documentation. It automatically creates preview environments when you make changes, so your team can review updates before publishing. Everything stays in your Git repository, giving you full version control over your documentation.

Doctave Studio is the companion desktop application that provides real-time previews, auto-complete suggestions, broken link checking, and spell checking. Together, these tools help teams create documentation that stays current and accurate.

Getting started with Doctave is straightforward. Here is how to use it effectively:

• Create a documentation folder in your code repository and write your content using Markdown files. Include a README.md file as your starting page.

• Install Doctave Studio on your computer to preview your documentation locally with real-time updates as you write.

• Set up your doctave.yml configuration file to define your documentation structure, theme colors, and navigation links.

• Connect your Git repository to Doctave through their platform. Every time you push changes, Doctave automatically updates your published documentation.

• For API documentation, add your OpenAPI specification file to your repository. Doctave will generate interactive API reference pages automatically.

• Use Git branches to manage different versions of your documentation. Create pull requests to review changes before publishing, and Doctave will generate preview links for each pull request.

• Git-based documentation workflow with version control

• Doctave Studio desktop editor with real-time preview

• OpenAPI specification support for API documentation

• Automatic preview environments for pull requests

• Multi-version documentation management

• Built-in search across all content

• Custom branding and theming options

• Reader analytics and feedback collection

• CI/CD integration for automatic deployment

• Password-protected documentation options