@cognidocs/cli
v1.0.2
Published
Beautiful documentation for TypeScript & React projects — CLI tool
Readme
@cognidocs/cli
⚠️ Looking for the main package? Install
cognidocsinstead for the best experience!
Quick Install
# Recommended: Use the main package
npm install -g cognidocs
# Or use this scoped package directly
npm install -g @cognidocs/cliAbout This Package
This is the CLI package for CogniDocs. While you can install this directly, we recommend using the main cognidocs package which provides:
- ✅ Better discoverability on npm
- ✅ Simpler installation command
- ✅ Official entry point for the project
- ✅ Same functionality with better UX
Documentation
For complete documentation, visit:
- Main Package: https://www.npmjs.com/package/cognidocs
- GitHub: https://github.com/abishekraj/cognidocs
- Live Demo: https://abishekraj.github.io/cognidocs/
Quick Start
# 1. Initialize your project
cognidocs init
# 2. Build your documentation
cognidocs build
# 3. Preview locally
cognidocs serveWhat is CogniDocs?
CogniDocs is a comprehensive documentation tool for JavaScript and TypeScript that automatically generates stunning documentation sites from your code with:
- 🤖 Multi-Framework Support - React, Next.js, Vue 3, and Svelte
- 🎨 12 Professional Themes - GitBook, GitHub, Nord, Dracula, and more
- 📊 Deep Analysis - Coverage reports, dependency graphs, and metrics
- 💎 Advanced Features - Mermaid.js diagrams, callout boxes, and more
License
MIT © Abishek Raj
