API Doc generator based on YUIDoc. We use this tool to document a large JavaScript game engine Fireball at docs-zh.fireball-x.com/api and self-document firedoc itself at:
- English: http://fireball-x.github.io/firedoc/ or http://fireball-x.github.io/firedoc/en
- 中文: http://fireball-x.github.io/firedoc/zh
FireDoc is forked from YUIDoc and added some powerful enhanced features at Syntax Guide.
YUIDoc is a Node.js application used at build time to generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a set of HTML pages including information about methods, properties, custom events and inheritance for JavaScript objects.
YUIDoc was originally written for the YUI Project; it uses YUI JavaScript and CSS in the generated files and it supports common YUI conventions like Custom Events. That said, it can be used easily and productively on non-YUI code.
$ npm install -g firedoc$ firedoc source-path --lang--lang option is required for multi-language description. Currently firedoc supports --en and --zh language option. Adding those option will generate docs for that specific language.
--markdown or --md is optional flag, which lets you get the markdown-based documentation to
directly host at Github or Bitbucket. Firedoc's github
hosted documentation is generated by itself.
To run test
$ npm testPlease see the CONTRIBUTING.md.
This software is free to use under the Yahoo Inc. BSD license. See the LICENSE file for license text and copyright information.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent