create-docs-engine
v2.0.0
Published
CLI tool to scaffold a new docs-engine documentation site
Maintainers
Readme
create-docs-engine
Scaffold a new docs-engine documentation site with one command.
Usage
npx create-docs-engine my-docs
cd my-docs
pnpm devFeatures
- Interactive CLI prompts for project configuration
- Support for npm, pnpm, and yarn
- Optional features (screenshots, mermaid, git integration)
- Ready-to-run SvelteKit project with docs-engine configured
- Sample documentation files included
Options
# Specify project name
npx create-docs-engine my-docs
# Interactive mode (will prompt for project name)
npx create-docs-engineWhat's Included
The generated project includes:
docs/- Markdown documentation filessrc/routes/- SvelteKit routes- Sample markdown files demonstrating features
- Configured package.json with scripts
- .gitignore file
- README.md
Development
After creating a project:
cd my-docs
pnpm dev # Start dev server
pnpm build # Build for production
pnpm preview # Preview production buildLicense
MIT
