SyntaxScribe¶
Generate clean, Markdown-based documentation for TypeScript, JavaScript, and Vue projects—automatically.
SyntaxScribe is a CLI-first tool that analyzes your codebase and generates comprehensive documentation without manual intervention. Perfect for developers who want professional docs with zero configuration.
🚀 Quick Start¶
Get up and running in under 2 minutes:
npm install -g syntax-scribe
syntax-scribe docs document -s "~/code/my-project" -d "~/code/my-docs/docs" -l your-license-key
Your docs are ready in ~/code/my-docs/docs
That's it! Your documentation is now ready for MkDocs, GitHub Pages, or any static site generator.
learn more Get Started →
✨ Key Features¶
- 🔄 Zero Configuration - Works out of the box with sensible defaults
- ⚡ Lightning Fast - Process thousands of files in seconds
- 📱 Multiple Formats - Markdown, HTML, JSON output support
- 🎯 Framework Agnostic - TypeScript, JavaScript, Vue, React, and more
- 🤖 CI/CD Ready - Perfect for automated documentation workflows
- 📚 MkDocs Compatible - Drop-in ready for popular documentation platforms
🤝 Support & Community¶
- 🐛 Found a bug? Report it on GitHub
- 💡 Feature request? Start a discussion
See it in action¶
I've run it against two popular open-source projects to demonstrate the quality and depth of documentation it generates:
VueUse Documentation¶
View the generated VueUse docs →
VueUse is a collection of essential Vue composition utilities with hundreds of functions. SyntaxScribe automatically analyzed the entire codebase and generated comprehensive documentation showing function signatures, parameters, return types, and relationships between utilities.
ESLint Documentation¶
View the generated ESLint docs →
The ESLint is a complex monorepo with multiple packages, rule definitions, and intricate TypeScript patterns. SyntaxScribe parsed through the complexity and created clean, navigable documentation that makes the codebase approachable.