canmove, Confirmed users
737
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jump to navigation
Jump to search
→Writing Documentation for the Add-on SDK
| Line 7: | Line 7: | ||
The "cfx docs" command launches a small web server in order to render the documentation in a browser. It relies on three things: | The "cfx docs" command launches a small web server in order to render the documentation in a browser. It relies on three things: | ||
* That the documentation is written in [http://daringfireball.net/projects/markdown/ Markdown syntax] | * That the documentation is written in [http://daringfireball.net/projects/markdown/ Markdown syntax] | ||
* That the API | * That the API elements are described in [https://wiki.mozilla.org/Jetpack/SDK/Writing_Documentation#APIDoc_Syntax APIDoc] syntax | ||
* That there are corresponding .js/.md files in the lib/docs directories (e.g. tabs.js/tabs.md) | * That there are corresponding .js/.md files in the lib/docs directories (e.g. tabs.js/tabs.md) | ||