{"_id":"@ackshaey/docco-kotlin","name":"@ackshaey/docco-kotlin","dist-tags":{"latest":"0.9.3"},"versions":{"0.9.3":{"name":"@ackshaey/docco-kotlin","description":"The Quick and Dirty Literate Programming Documentation Generator (with Kotlin support)","keywords":["documentation","docs","generator","literate","coffeescript","kotlin"],"author":{"name":"Jeremy Ashkenas","url":"original"},"version":"0.9.3","license":"MIT","repository":{"type":"git","url":"git+https://github.com/ackshaey/docco.git"},"engines":{"node":">=0.2.0"},"dependencies":{"commander":"~ 8.3.0","marked":"~ 4.0.3","fs-extra":"~ 10.0.0","underscore":"~ 1.13.1","highlight.js":"~ 11.3.1"},"main":"./docco","bin":{"docco":"bin/docco"},"gitHead":"1c0b9416b1e791118ec6de48446514a5c6570042","bugs":{"url":"https://github.com/ackshaey/docco/issues"},"homepage":"https://github.com/ackshaey/docco#readme","_id":"@ackshaey/docco-kotlin@0.9.3","_nodeVersion":"19.9.0","_npmVersion":"9.6.3","dist":{"integrity":"sha512-8OkLbVnuW01KIegejIpo2FkDJi5dEU3i6ONHk+cTobLbfGR/ZjqELav6ghmhbzNsnrSgeqRVgCWLDLp00mmv6A==","shasum":"d5049d449905dac9900375969c75f3586b6c462a","tarball":"https://registry.npmjs.org/@ackshaey/docco-kotlin/-/docco-kotlin-0.9.3.tgz","fileCount":53,"unpackedSize":1519411,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIBEs3G2kpH+U3ozLPbLvR7wui5I1L4nT1J/z7ZZS7buqAiAYxI9di3WtOWUa2d+Ssjb/krrZuzA53BOFMVUbgOu1Zg=="}]},"_npmUser":{"name":"ackshaey","email":"ackshaey@gmail.com"},"directories":{},"maintainers":[{"name":"ackshaey","email":"ackshaey@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/docco-kotlin_0.9.3_1763286852408_0.19576513336588075"},"_hasShrinkwrap":false}},"time":{"created":"2025-11-16T09:54:12.312Z","0.9.3":"2025-11-16T09:54:12.651Z","modified":"2025-11-16T09:54:12.967Z"},"maintainers":[{"name":"ackshaey","email":"ackshaey@gmail.com"}],"description":"The Quick and Dirty Literate Programming Documentation Generator (with Kotlin support)","homepage":"https://github.com/ackshaey/docco#readme","keywords":["documentation","docs","generator","literate","coffeescript","kotlin"],"repository":{"type":"git","url":"git+https://github.com/ackshaey/docco.git"},"author":{"name":"Jeremy Ashkenas","url":"original"},"bugs":{"url":"https://github.com/ackshaey/docco/issues"},"license":"MIT","readme":"# Docco (with Kotlin Support)\n\n```\n ____\n/\\  _`\\\n\\ \\ \\/\\ \\        ___         ___         ___         ___\n \\ \\ \\ \\ \\      / __`\\      /'___\\      /'___\\      / __`\\\n  \\ \\ \\_\\ \\    /\\ \\ \\ \\    /\\ \\__/     /\\ \\__/     /\\ \\ \\ \\\n   \\ \\____/    \\ \\____/    \\ \\____\\    \\ \\____\\    \\ \\____/\n    \\/___/      \\/___/      \\/____/     \\/____/     \\/___/\n```\n\nThis is a fork of [jashkenas/docco](https://github.com/jashkenas/docco) with **Kotlin language support** added.\n\n## What's New in This Fork\n\n### ✨ Kotlin Language Support\n\nThis fork adds support for **Kotlin** (`.kt` files) to Docco's language definitions.\n\n- **File extension**: `.kt`\n- **Comment style**: `//` (single-line comments, same as Java/JavaScript/C++)\n- **Syntax highlighting**: Uses Highlight.js's built-in Kotlin support\n\n### Changes Made\n\n- Added Kotlin entry to `resources/languages.json`:\n  ```json\n  \".kt\": {\"name\": \"kotlin\", \"symbol\": \"//\"}\n  ```\n\nThis enables Docco to generate beautiful literate programming documentation for Kotlin source code, just like it does for Java, JavaScript, Python, and other supported languages.\n\n## Original Docco Information\n\nDocco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.\n\nFor more information about the original project, see: http://ashkenas.com/docco/\n\n## Installation\n\n### Install from npm (once published)\n\n```bash\nnpm install -g @ackshaey/docco-kotlin\n```\n\n### Install from source\n\n```bash\ngit clone https://github.com/ackshaey/docco.git\ncd docco\nnpm install\nnpm link\n```\n\n## Usage\n\n```bash\ndocco [options] FILES\n```\n\n### Options\n\n- `-h, --help` - Output usage information\n- `-V, --version` - Output the version number\n- `-l, --layout [layout]` - Choose a built-in layout (parallel, linear)\n- `-c, --css [file]` - Use a custom CSS file\n- `-o, --output [path]` - Use a custom output path\n- `-t, --template [file]` - Use a custom .jst template\n- `-e, --extension [ext]` - Use the given file extension for all inputs\n- `-L, --languages [file]` - Use a custom languages.json\n- `-m, --marked [file]` - Use custom marked options\n\n### Kotlin Example\n\n```bash\n# Generate documentation for Kotlin files\ndocco src/**/*.kt\n\n# With custom output directory\ndocco -o docs src/**/*.kt\n```\n\n## Supported Languages\n\nThis fork supports all the original Docco languages plus:\n\n- **Kotlin** (`.kt`) - NEW!\n- JavaScript, CoffeeScript, Ruby, Python\n- Java, Scala, C, C++, C#\n- And many more...\n\nFor the complete list, see [resources/languages.json](resources/languages.json).\n\n## Why This Fork?\n\nThe original Docco project doesn't currently support Kotlin. This fork was created to enable documentation generation for Kotlin codebases, particularly for projects like [Firecode.io](https://firecode.io) that use Kotlin for their problem sets and need to generate annotated solution documentation.\n\n## Contributing to Upstream\n\nIf you'd like to see Kotlin support in the official Docco project, please consider:\n\n1. Opening an issue at [jashkenas/docco](https://github.com/jashkenas/docco/issues)\n2. Submitting a pull request with these changes\n\n## License\n\nThis project maintains the same license as the original Docco project.\n\nSee [LICENSE](LICENSE) for details.\n\n## Credits\n\n- **Original Docco**: Created by [Jeremy Ashkenas](https://github.com/jashkenas)\n- **Kotlin Support**: Added by [Ackshaey Singh](https://github.com/ackshaey)\n\n---\n\n## Links\n\n- **Original Docco Repository**: https://github.com/jashkenas/docco\n- **This Fork**: https://github.com/ackshaey/docco\n- **Highlight.js** (provides syntax highlighting): https://highlightjs.org/\n- **Marked** (Markdown parser): https://marked.js.org/\n","readmeFilename":"README.md","_rev":"1-d1c23bc4b0bf552ae1739a2955ee55eb"}