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 3: | Line 3: | ||
== Writing Documentation for the Add-on SDK == | == Writing Documentation for the Add-on SDK == | ||
Documentation in the Add-on SDK is a self-contained system within the SDK itself. All of the documentation is generated on the fly from | Documentation in the Add-on SDK is a self-contained system within the SDK itself. All of the documentation is generated on the fly from Markdown files located in the directory structure. SDK documentation is viewable either as source (at any time) or as a web page after the SDK has been activated and the "cfx docs" command has been run from the command line. | ||
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: | ||