{"id":21935259,"url":"https://github.com/abritinthebay/docco-es","last_synced_at":"2026-05-11T03:21:38.404Z","repository":{"id":57213867,"uuid":"143084090","full_name":"abritinthebay/docco-es","owner":"abritinthebay","description":"A Quick \u0026 Simple Documentation Generator.","archived":false,"fork":false,"pushed_at":"2018-08-01T00:46:20.000Z","size":1300,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-14T23:14:27.095Z","etag":null,"topics":["cli","docs","documentation","es6","esnext","generator"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abritinthebay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-01T00:35:47.000Z","updated_at":"2022-05-21T20:03:53.000Z","dependencies_parsed_at":"2022-08-29T02:10:42.865Z","dependency_job_id":null,"html_url":"https://github.com/abritinthebay/docco-es","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abritinthebay%2Fdocco-es","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abritinthebay%2Fdocco-es/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abritinthebay%2Fdocco-es/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abritinthebay%2Fdocco-es/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abritinthebay","download_url":"https://codeload.github.com/abritinthebay/docco-es/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244966461,"owners_count":20539794,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","docs","documentation","es6","esnext","generator"],"created_at":"2024-11-29T00:19:07.666Z","updated_at":"2026-05-11T03:21:38.343Z","avatar_url":"https://github.com/abritinthebay.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docco-ES\n\t       __\n\t  ____/ /___  ______________        ___  _____\n\t / __  / __ \\/ ___/ ___/ __ \\______/ _ \\/ ___/\n\t/ /_/ / /_/ / /__/ /__/ /_/ /_____/  __(__  )\n\t\\__,_/\\____/\\___/\\___/\\____/      \\___/____/\n[![npm](https://img.shields.io/npm/v/docco-es.svg?style=for-the-badge)](https://www.npmjs.com/package/docco-es)![npm](https://img.shields.io/npm/l/docco-es.svg?style=for-the-badge)[![Coverage Status](https://img.shields.io/coveralls/github/abritinthebay/docco-es.svg?style=for-the-badge)](https://coveralls.io/repos/github/abritinthebay/docco-es)\n\n## About\n\nDocco-ES is a quick-and-simple documentation generator. Inspired by the concepts of [Literate Programming](https://en.wikipedia.org/wiki/Literate_programming) it allows you to see your code's comments\nalong side the code as documentation.\n\nThis is a modern, updated, JavaScript fork of Jeremy Ashkenas' original Literate CoffeeScript implementation.\n\n## Installation\n\n\tnpm install -g docco-es\n\n## Usage\n\n\tdocco [options] FILES\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 layouts (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* `-T, --throw` Throw errors if code syntax highlighting fails\n* `-v, --verbose` Shows all files as they are proccessed rather than a summary\n* `-z, --zip [file]` Use layout files compressed as a zip\n\n## Layouts\n\nA layout is composed of a CSS file and a JST file. You can provide both of these to Docco to create your own layouts but Docco-ES ships with three layouts built-in.\n\n* **Linear**, a simple, single column, layout that the documentation linked above uses.\n* **Parallel**, a two column layout that shows your comments on the left as a kind of annotation to the code, displayed on the right.\n* **Markdown**, a special case in that it allows you to output the code formatted as a [markdown](https://en.wikipedia.org/wiki/Markdown) document. With the code marked up in backticks and the comments as regular text. This is especially useful if you want to convert to another format - like LaTeX or a Literate Programming form of your chosen language. All code blocks are marked up with the language matching the extension of the processed file.\n\n\n## Documentation\nThe [documentation for Docco-ES](http://abritinthebay.github.com/docco-es) is generated *by Docco-ES* using the Linear layout. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabritinthebay%2Fdocco-es","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabritinthebay%2Fdocco-es","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabritinthebay%2Fdocco-es/lists"}