See Syntax Scribe In Action

Real documentation sites generated from VueUse and ESLint codebases. These aren't demos—they're production-quality sites built in under 30 seconds.

2,847
Total Files
2s
Avg Generation

Two Major Open Source Projects

We chose these projects to showcase Syntax Scribe's capabilities across different codebases and documentation needs

VueUse

Essential Vue Composition Utilities

Collection of utility functions for Vue 3

679
Files
1,600+
Functions
1.23 seconds
Generation Time
51K+
Lines of Code

Key Features Generated:

  • Auto-generated documentation for 1,600+ functions
  • Type-safe documentation with TypeScript integration
  • Complete function signatures and parameters

ESLint

Pluggable JavaScript Linter

Find and fix problems in JavaScript code

2,454
Files
4,000+
Functions
2.51 seconds
Generation Time
264K+
Lines of Code

Key Features Generated:

  • Auto-generated documentation for 4,000+ functions
  • Type-safe documentation with TypeScript integration
  • Complete function signatures and parameters

Behind the Scenes: How It Works

See the exact commands used and the results achieved for each project

Exact Commands Used

Terminal
$ syntax-scribe docs document -s ~/vueuse -d ~/vueuse-docs/docs
🔍 Analyzing 679 files...
$ syntax-scribe docs init -d ~/vueuse-docs -n "VueUse Documentation"
🏗️ Creating MkDocs site structure...
$ syntax-scribe docs nav -d ~/vueuse-docs
📚 Generating intelligent navigation...
$ syntax-scribe docs serve -d ~/vueuse-docs
🚀 Serving at http://localhost:8000
✅ Total time: 1.23s • Lines of code: 51,291

What Was Generated

Documentation Features:

  • Auto-generated documentation for 1,600+ functions
  • Type-safe documentation with TypeScript integration
  • Complete function signatures and parameters

Performance Metrics:

1.23s
Generation Time
51,291
Lines of Code

Ready to Generate Your Own?

Join the developers who've already automated their documentation workflow with these proven results