Engineer-first documentation generator that turns your TypeScript code into beautiful, interactive docs.

• 🎯 Type-Driven: Auto-generates docs from TypeScript types
• 🚀 Zero Config: Works out of the box
• ⚡ Fast: Incremental builds with caching
• 🎨 Beautiful UI: Modern, interactive documentation
• 🔌 Extensible: Powerful plugin system

npm install -D @opensyntaxhq/autodocs npx autodocs init npx autodocs build

Autodocs supports incremental builds with a persistent cache and a watch mode for fast feedback.

# Clean cache and run a full build rm -rf .autodocs-cache npx autodocs build # Watch for changes and update docs.json without rebuilding UI assets npx autodocs watch

Config options:

export default defineConfig({ cache: true, cacheDir: '.autodocs-cache', });

# Install dependencies npm install # Build all packages npm run build # Run in development mode npm run dev # Run tests npm run test # Lint code npm run lint

This project ships with a full CI/CD pipeline using GitHub Actions and Netlify:

• Lint, type-check, format, tests with coverage
• Staging deploys from develop
• Production deploys from main
• PR preview deployments
• CodeQL, dependency review, Trivy, npm audit

If you don’t have a custom domain yet, Netlify will use a default *.netlify.app URL.
When you’re ready, set SITE_URL (repo secret or env var) to generate sitemap.xml and robots.txt.

You can also set it in config:

export default defineConfig({ output: { siteUrl: 'https://your-domain.example', }, });

npm run docs:build

• packages/core - Core parsing engine
• packages/cli - Command-line interface
• packages/ui - React documentation UI
• packages/plugins - Official plugins

Apache-2.0