About DocuGen
DocuGen CLI: Simplify Documentation
DocuGen CLI is a lightweight, extensible tool designed to transform your Markdown files into professional, interactive documentation websites. Whether you're documenting APIs, libraries, or internal processes, DocuGen automates the heavy lifting.
Why DocuGen?
- Zero Configuration: Start with a single command—docugen init—and get a fully functional docs site.
- Themes & Plugins: Choose from built-in themes or create your own. Extend functionality with community plugins.
- One-Click Deploy: Publish to GitHub Pages, Netlify, or Vercel with a single command.
Workflow
- Write your content in Markdown.
- Run docugen build to generate static HTML.
- Deploy with docugen deploy.
Key Features
Markdown-First
Write in plain Markdown. DocuGen handles tables, code blocks, and even embedded diagrams.
Live Preview
See changes in real-time with the built-in dev server. Run docugen serve to start.
Plugin Ecosystem
Add search, analytics, or custom components with plugins. Install via docugen plugin add.
Getting Started
Getting Started
Install globally:
npm install -g docugen-cli
Initialize a new project:
bashCopy
docugen init my-docs
Start the dev server:
bashCopy
cd my-docs && docugen serve
Deploy to GitHub Pages:
bashCopy
docugen deploy --target gh-pages
For advanced usage, check the plugin directory.
Technical Overview
A command-line tool to generate beautiful, customizable documentation from Markdown files. Supports themes, plugins, and one-click deployment.