0.4.2 • Published 2 years ago

doctave-js v0.4.2

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

JS wrapper for Doctave

For more information visit the Doctave original docs.

Motivation: To be able to use Doctave with npx for a smaller footprint.

** Disclaimer: This package is aligned with my personal fork and thus could produce a slightly different output.


Doctave is an opinionated documentation site generator that converts your Markdown files into a beautiful documentation site with minimal effort.

Doctave is not a generic static site generator - it is only meant for generating documentation sites from Markdown. This allows the tool to be much simpler than other solutions, with fewer configuration steps.

This open source tool is built and maintained by Doctave.com.

Features

Doctave comes with a number of documentation-specific features out of the box. No plugins needed.

  • Mermaid.js diagrams
  • Offline full-text search
  • Local live-reloading server
  • Broken links checking
  • Typesetting for mathematical formulas
  • Responsive design
  • Dark mode
  • GitHub flavored markdown
  • Minimal configuration
  • Fast build times (Doctave is built with Rust)