syntax-scribe/README.md

Effortless code documentation generator for JavaScript, TypeScript, Vue, and TSX projects with MkDocs integration.

syntax-scribe
=================

> Effortless code documentation generation for JavaScript, TypeScript, Vue, and TSX projects


**Syntax Scribe** automatically generates beautiful, professional documentation from your source code with zero configuration required. Transform your codebase into comprehensive MkDocs sites in minutes.

## ✨ Features

- 🔍 **Deep Code Analysis** - Parses functions, interfaces, types, and comments
- 📚 **MkDocs Integration** - Generates complete documentation sites with Material theme
- 🎯 **Multi-Language Support** - JavaScript, TypeScript, Vue, and TSX files
- 🚀 **CLI Interface** - Simple commands for documentation generation
- 📝 **Clean Markdown** - Ready for GitHub READMEs, wikis, and static sites
- 🔒 **Local & Private** - All processing happens on your machine
- ⚡ **Zero Configuration** - Works out of the box with sensible defaults

## 🚀 Quick Start

### Installation

```bash
npm install -g syntax-scribe
```

### Generate Documentation

```bash
# Generate docs from your project
syntax-scribe docs document -s "./src" -d "./docs" 

# Initialize MkDocs site
syntax-scribe docs init -d "./my-docs" -n "My Project" 

# Serve locally
syntax-scribe docs serve -d "./my-docs" 
```

## 📖 Full Documentation

Visit [syntaxscribe.com](https://syntaxscribe.com) for complete documentation, examples, and deployment guides.

## 🛠️ Commands

| Command | Description |
|---------|-------------|
| `document` | Generate documentation from source code |
| `init` | Initialize MkDocs site structure |
| `nav` | Generate navigation for MkDocs |
| `serve` | Start local development server |
| `build` | Build static site for deployment |

## 📁 Example Output

Syntax Scribe generates structured documentation including:

- 📊 Function signatures and parameters
- 🎯 Interface and type definitions  
- 📦 Import/export mappings
- 🔗 Cross-references and navigation
- 📈 Code statistics and summaries

## 🌟 Perfect For

- **Open Source Projects** - Professional docs for GitHub repositories
- **Team Documentation** - Internal codebase documentation
- **Client Handoffs** - Comprehensive project documentation
- **Design Systems** - Component library documentation
- **API Documentation** - Automated API reference generation

## 🔧 Requirements

- Node.js 14+
- TypeScript/JavaScript project



## 🤝 Support

- 📖 [Documentation](https://syntax-scribe.github.io/syntax-scribe-docs/)
- 🐛 [Issues](https://github.com/syntax-scribe/feedback/issues)
- 💬 [Feedback](https://github.com/syntax-scribe/feedback/discussions)

---

**Ready to transform your code into beautiful documentation?** Install Syntax Scribe today and see the difference professional documentation makes.