🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
syntax-scribe
Advanced tools
syntax-scribe - npm Package Compare versions
Comparing version 0.1.0 to 0.1.1
| { | ||
| "name": "syntax-scribe", | ||
| "version": "0.1.0", | ||
| "description": "A CLI tool for generating documentation for TypeScript and JavaScript code.", | ||
| "version": "0.1.01", | ||
| "description": "Effortless code documentation generator for JavaScript, TypeScript, Vue, and TSX projects with MkDocs integration.", | ||
| "bin": { | ||
@@ -12,10 +12,27 @@ "syntax-scribe": "launcher/syntax-scribe" | ||
| "keywords": [ | ||
| "documentation", | ||
| "docs", | ||
| "typescript", | ||
| "javascript", | ||
| "vue", | ||
| "tsx", | ||
| "mkdocs", | ||
| "code-analysis", | ||
| "api-docs", | ||
| "markdown", | ||
| "cli", | ||
| "typescript", | ||
| "documentation", | ||
| "developer-tools", | ||
| "static-site-generator", | ||
| "code-documentation", | ||
| "jsdoc", | ||
| "static analysis", | ||
| "javascript" | ||
| "technical-writing", | ||
| "documentation-generator", | ||
| "ast-parser", | ||
| "source-code-analysis" | ||
| ], | ||
| "author": "Patrick Wright", | ||
| "author": { | ||
| "name": "Patrick Wright", | ||
| "email": "patrick@syntaxscribe.com", | ||
| "url": "https://syntaxscribe.com" | ||
| }, | ||
| "license": "SEE LICENSE IN LICENSE.txt", | ||
@@ -22,0 +39,0 @@ "engines": { |
212
README.md
| syntax-scribe | ||
| ================= | ||
| A new CLI generated with oclif | ||
| > Effortless code documentation generation for JavaScript, TypeScript, Vue, and TSX projects | ||
| [](https://oclif.io) | ||
| [](https://npmjs.org/package/syntax-scribe) | ||
| [](https://npmjs.org/package/syntax-scribe) | ||
| **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 | ||
| <!-- toc --> | ||
| * [Usage](#usage) | ||
| * [Commands](#commands) | ||
| <!-- tocstop --> | ||
| # Usage | ||
| <!-- usage --> | ||
| ```sh-session | ||
| $ npm install -g syntax-scribe | ||
| $ syntax-scribe COMMAND | ||
| running command... | ||
| $ syntax-scribe (--version) | ||
| syntax-scribe/0.0.03 linux-x64 node-v22.14.0 | ||
| $ syntax-scribe --help [COMMAND] | ||
| USAGE | ||
| $ syntax-scribe COMMAND | ||
| ... | ||
| ``` | ||
| <!-- usagestop --> | ||
| # Commands | ||
| <!-- commands --> | ||
| - [syntax-scribe](#syntax-scribe) | ||
| - [Usage](#usage) | ||
| - [Commands](#commands) | ||
| - [`syntax-scribe docs`](#syntax-scribe-docs) | ||
| - [`syntax-scribe docs build`](#syntax-scribe-docs-build) | ||
| - [`syntax-scribe docs document`](#syntax-scribe-docs-document) | ||
| - [`syntax-scribe docs init`](#syntax-scribe-docs-init) | ||
| - [`syntax-scribe docs nav`](#syntax-scribe-docs-nav) | ||
| - [`syntax-scribe docs serve`](#syntax-scribe-docs-serve) | ||
| - [`syntax-scribe help [COMMAND]`](#syntax-scribe-help-command) | ||
| - 🔍 **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 | ||
| ## `syntax-scribe docs` | ||
| ### Installation | ||
| Manage and preview MkDocs Material documentation site | ||
| ```bash | ||
| npm install -g syntax-scribe | ||
| ``` | ||
| USAGE | ||
| $ syntax-scribe docs | ||
| DESCRIPTION | ||
| Manage and preview MkDocs Material documentation site | ||
| ### Generate Documentation | ||
| EXAMPLES | ||
| $ cli docs init --siteName="My Docs" | ||
| ```bash | ||
| # Generate docs from your project | ||
| syntax-scribe docs document -s "./src" -d "./docs" | ||
| $ cli docs nav | ||
| # Initialize MkDocs site | ||
| syntax-scribe docs init -d "./my-docs" -n "My Project" | ||
| $ cli docs serve | ||
| $ cli docs build | ||
| # Serve locally | ||
| syntax-scribe docs serve -d "./my-docs" | ||
| ``` | ||
| ## `syntax-scribe docs build` | ||
| ## 📖 Full Documentation | ||
| Build the static site using mkdocs build | ||
| Visit [syntaxscribe.com](https://syntaxscribe.com) for complete documentation, examples, and deployment guides. | ||
| ``` | ||
| USAGE | ||
| $ syntax-scribe docs build -l <value> [-d <value>] | ||
| ## 🛠️ Commands | ||
| FLAGS | ||
| -d, --dir=<value> [default: docs-site] Project directory | ||
| -l, --licenseKey=<value> (required) syntax scribe license key | ||
| | 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 | | ||
| DESCRIPTION | ||
| Build the static site using mkdocs build | ||
| ## 📁 Example Output | ||
| EXAMPLES | ||
| $ syntax-scribe docs build -d docs-site -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx | ||
| Syntax Scribe generates structured documentation including: | ||
| $ syntax-scribe docs build -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx | ||
| ``` | ||
| - 📊 Function signatures and parameters | ||
| - 🎯 Interface and type definitions | ||
| - 📦 Import/export mappings | ||
| - 🔗 Cross-references and navigation | ||
| - 📈 Code statistics and summaries | ||
| ## 🌟 Perfect For | ||
| ## `syntax-scribe docs document` | ||
| - **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 | ||
| Genearate documentation for a TypeScript or Javascript project. | ||
| ## 🔧 Requirements | ||
| ``` | ||
| USAGE | ||
| $ syntax-scribe docs document -d <value> -l <value> -s <value> | ||
| - Node.js 14+ | ||
| - TypeScript/JavaScript project | ||
| FLAGS | ||
| -d, --docDirectory=<value> (required) directory to create documentation in | ||
| -l, --licenseKey=<value> (required) syntax scribe license key | ||
| -s, --sourceDirectory=<value> (required) source directory to document | ||
| DESCRIPTION | ||
| Genearate documentation for a TypeScript or Javascript project. | ||
| EXAMPLES | ||
| $ syntax-scribe docs document -s "/Users/patrickwright/code/my-typescript-project" -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx | ||
| ## 🤝 Support | ||
| $ syntax-scribe docs document -s "/Users/patrickwright/code/my-typescript-project" -d /Users/patrickwright/gen/syntax-01/docs | ||
| ``` | ||
| - 📖 [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) | ||
| --- | ||
| ## `syntax-scribe docs init` | ||
| Initialize a MkDocs Material documentation site | ||
| ``` | ||
| USAGE | ||
| $ syntax-scribe docs init -l <value> [-d <value>] [-n <value>] | ||
| FLAGS | ||
| -d, --dir=<value> [default: docs-site] Output directory | ||
| -l, --licenseKey=<value> (required) syntax scribe license key | ||
| -n, --siteName=<value> [default: My Project Docs] Site name | ||
| DESCRIPTION | ||
| Initialize a MkDocs Material documentation site | ||
| EXAMPLES | ||
| $ syntax-scribe docs init -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx -n "My Project Docs" | ||
| $ syntax-scribe docs init -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx | ||
| ``` | ||
| ## `syntax-scribe docs nav` | ||
| Regenerate the nav section of mkdocs.yml based on Markdown files | ||
| ``` | ||
| USAGE | ||
| $ syntax-scribe docs nav -l <value> [-d <value>] | ||
| FLAGS | ||
| -d, --dir=<value> [default: docs-site] Project directory | ||
| -l, --licenseKey=<value> (required) syntax scribe license key | ||
| DESCRIPTION | ||
| Regenerate the nav section of mkdocs.yml based on Markdown files | ||
| EXAMPLES | ||
| $ syntax-scribe docs nav -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx " | ||
| ``` | ||
| ## `syntax-scribe docs serve` | ||
| Serve your documentation locally using mkdocs serve | ||
| ``` | ||
| USAGE | ||
| $ syntax-scribe docs serve -l <value> [-d <value>] | ||
| FLAGS | ||
| -d, --dir=<value> [default: docs-site] Project directory | ||
| -l, --licenseKey=<value> (required) syntax scribe license key | ||
| DESCRIPTION | ||
| Serve your documentation locally using mkdocs serve | ||
| EXAMPLES | ||
| $ syntax-scribe docs serve -d /Users/patrickwright/gen/syntax-01/docs -l xxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx " | ||
| ``` | ||
| ## `syntax-scribe help [COMMAND]` | ||
| Display help for syntax-scribe. | ||
| ``` | ||
| USAGE | ||
| $ syntax-scribe help [COMMAND...] [-n] | ||
| ARGUMENTS | ||
| COMMAND... Command to show help for. | ||
| FLAGS | ||
| -n, --nested-commands Include all nested commands in the output. | ||
| DESCRIPTION | ||
| Display help for syntax-scribe. | ||
| ``` | ||
| <!-- commandsstop --> | ||
| **Ready to transform your code into beautiful documentation?** Install Syntax Scribe today and see the difference professional documentation makes. |
New alerts
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
Unidentified License
License(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.
Found 1 instance in 1 package
Fixed alerts
Unidentified License
License(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
8262
-17.36%- Number of lines in readme file
88
-54.17%- Number of medium supply chain risk alerts
2
100%No dependency changes