{"id":13558320,"url":"https://github.com/senchalabs/jsduck","last_synced_at":"2025-05-14T06:14:11.806Z","repository":{"id":1099530,"uuid":"960600","full_name":"senchalabs/jsduck","owner":"senchalabs","description":"Simple JavaScript Duckumentation generator.","archived":false,"fork":false,"pushed_at":"2020-04-16T21:37:08.000Z","size":6202,"stargazers_count":1499,"open_issues_count":87,"forks_count":240,"subscribers_count":93,"default_branch":"master","last_synced_at":"2025-04-13T13:54:18.243Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.sencha.com/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/senchalabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-10-04T13:40:38.000Z","updated_at":"2025-04-07T21:04:33.000Z","dependencies_parsed_at":"2022-07-06T08:01:26.592Z","dependency_job_id":null,"html_url":"https://github.com/senchalabs/jsduck","commit_stats":null,"previous_names":[],"tags_count":83,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senchalabs%2Fjsduck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senchalabs%2Fjsduck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senchalabs%2Fjsduck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senchalabs%2Fjsduck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/senchalabs","download_url":"https://codeload.github.com/senchalabs/jsduck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248724587,"owners_count":21151559,"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":[],"created_at":"2024-08-01T12:04:52.653Z","updated_at":"2025-04-13T13:54:22.536Z","avatar_url":"https://github.com/senchalabs.png","language":"Ruby","funding_links":[],"categories":["Ruby","Web 后端","Documentation","others","Documentation [🔝](#readme)","文档"],"sub_categories":["Runner","运行器","运行器e2e测试"],"readme":"![JSDuck](https://raw.github.com/senchalabs/jsduck/master/opt/jsduck-logo-dark.png)\n===================================================================================\n\n**Warning: JSDuck is no more maintained!**\n- If you're looking to adopt a documentation tool, try something else.\n- If you're using JSDuck, consider moving over to something else.\n- Even Sencha itself doesn't use it any more, they use some internal tool, that's not available publicly.\n- If you'd like to take over the maintenance of JSDuck, contact me by creating an issue.\n\n[![Build Status](https://travis-ci.org/senchalabs/jsduck.png)](https://travis-ci.org/senchalabs/jsduck)\n\nAPI documentation generator for Sencha JavaScript frameworks.\n\nJSDuck aims to be a better documentation generator for [Ext JS][] than\nthe old [ext-doc][] was. It is used by Sencha to document [Ext JS\n4][ext4-docs], [Sencha Touch][touch2-docs] and [several other][other-docs]\nproducts.\n\nThe highlights of JSDuck are [Markdown][] support and keeping you DRY\nby inferring a lot of information from code.  Read the\n[documentation][] for full overview.\n\n**New to JSDuck?** Watch [introductory talk by Nick Poulden][video]:\n\n[\u003cimg src=\"http://b.vimeocdn.com/ts/227/178/227178682_200.jpg\" alt=\"SenchaCon 2011 JSDuck talk\" /\u003e][video]\n\n[Ext JS]: http://www.sencha.com/products/js/\n[ext-doc]: http://code.google.com/p/ext-doc/\n[Markdown]: http://daringfireball.net/projects/markdown/\n[ext4-docs]: http://docs.sencha.com/extjs/\n[touch2-docs]: http://docs.sencha.com/touch/\n[other-docs]: http://docs.sencha.com/\n[documentation]: https://github.com/senchalabs/jsduck/wiki\n[video]: http://vimeo.com/33465319\n\nGetting it\n----------\n\nStandard rubygems install should do:\n\n    $ [sudo] gem install jsduck\n\nOr download the [Windows binary][winbin]. When you run into problems,\nsee the [installation guide][].\n\n[winbin]: https://github.com/senchalabs/jsduck/releases\n[installation guide]: https://github.com/senchalabs/jsduck/wiki/Installation\n\nUsage\n-----\n\nFor the simplest test-run just use the `--builtin-classes` option to\nwrite documentation for JavaScript builtin classes like Array, String\nand Object into `docs` directory:\n\n    $ jsduck --builtin-classes --output docs\n\nTo generate docs for [Ext JS 4][] add path to the corresponding src/ dir:\n\n    $ jsduck ext-4.2.1/src --output docs\n\nAnd to create docs for your own Ext JS project, list the directory\nwith your files in addition to the Ext JS source files (this way the\ndocs of your classes will list all the properties and methods they\ninherit from Ext JS classes):\n\n    $ jsduck ext-4.2.1/src my-project/js --output docs\n\nUnfortunately the above will throw lots of warnings at you, as\nbuilding the full Ext JS docs requires lots of additional settings.\nFor start you might want to simply ignore all these warnings\noriginating from Ext JS source:\n\n    $ jsduck ext-4.2.1/src my-project/js --output docs \\\n             --warnings=-all:ext-4.2.1/src\n\nBut see the [Usage guide][] for more information on building Ext JS 4\ndocs.\n\n[Ext JS 4]: http://www.sencha.com/products/extjs/\n[Usage guide]: https://github.com/senchalabs/jsduck/wiki/Usage\n\n\nDocumenting your code\n---------------------\n\nRead the [documentation][] and take a look at [example.js][example].\n\n[example]: https://github.com/senchalabs/jsduck/blob/master/opt/example.js\n\n\nHacking it\n----------\n\nSee [Hacking guide](https://github.com/senchalabs/jsduck/wiki/Hacking) in wiki.\n\n\nWho's using JSDuck?\n-------------------\n\n- Appcelerator [Titanium SDK](http://docs.appcelerator.com/titanium/2.0/index.html)\n- AT\u0026T [API Platform SDK for HTML5](https://code-api-att.com/SenchaSdk20Drop23Docs/)\n- Bryntum [Siesta unit testing framework](http://www.bryntum.com/docs/siesta/)\n- [CKEditor](http://docs.ckeditor.com)\n- [GeoExt 2](https://github.com/geoext/geoext2)\n- Rally Software [Rally App SDK](https://prod.help.rallydev.com/apps/2.0rc1/doc/)\n- Wikimedia Foundation [MediaWiki](https://doc.wikimedia.org/mediawiki-core/master/js/)\n  and [VisualEditor](https://doc.wikimedia.org/VisualEditor/master/)\n- [Sencha](http://docs.sencha.com) - obviously :)\n\nThese are some that we know of. Want your project listed here? Drop us a line.\n\n\nCopying\n-------\n\nJSDuck is distributed under the terms of the GNU General Public\nLicense version 3.\n\nJSDuck was developed by [Rene Saarsoo](http://triin.net),\nwith contributions from\n[Nick Poulden](https://github.com/nick),\n[Ondřej Jirman](https://github.com/megous),\n[Thomas Aylott](https://github.com/subtleGradient),\n[Dave Thompson](https://github.com/limscoder),\n[Ed Spencer](https://github.com/edspencer),\n[Rob Dougan](https://github.com/rdougan),\n[Scott Whittaker](https://github.com/scottrobertwhittaker),\n[Timo Tijhof](https://github.com/Krinkle),\n[Brian Moeskau](https://github.com/bmoeskau),\n[Garry Yao](https://github.com/garryyao),\n[Yasin Okumus](https://github.com/lacivert),\n[Nicholas Boll](https://github.com/NicholasBoll) and\nKatherine Chu.\n\nMany thanks goes also to those who have most eagerly reported bugs:\n[Ryan Nauman](https://github.com/ryan-nauman),\n[Raphael Franchet](https://github.com/raphdulaf),\n[atian25](https://github.com/atian25),\n[burnnat](https://github.com/burnnat),\n[Raphael Pigulla](https://github.com/pigulla),\n[Dmitry Bakaleinik](https://github.com/demongloom),\n[Alan Lindsay](https://github.com/alindsay55661),\n[Corey Butler](https://github.com/coreybutler),\n[Nickolay Platonov](https://github.com/SamuraiJack),\n[Matt Greer](https://github.com/city41),\n[Richard](https://github.com/ritcoder) and\n[Dmitry Pashkevich](https://github.com/dpashkevich).\n\nThere are lots of others I haven't named here, who have provided their\ninput.\n\n\nChangelog\n---------\n\nSee [the Releases page](https://github.com/senchalabs/jsduck/releases).\n\n\nMore questions?\n---------------\n\nFeel free to [post an issue][issues], but read the [FAQ][] first.\n\n[issues]: https://github.com/senchalabs/jsduck/issues\n[FAQ]: https://github.com/senchalabs/jsduck/wiki/FAQ\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsenchalabs%2Fjsduck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsenchalabs%2Fjsduck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsenchalabs%2Fjsduck/lists"}