17
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jetpack/SDK/Writing Documentation (view source)
Revision as of 20:03, 18 August 2010
, 18 August 2010→Writing Docs For Your Own Modules
| Line 77: | Line 77: | ||
In the jetpack-sdk/packages/<your module> directory, you can include a file called README.md. This file may contain some high level-level information about the package. The README.md and package.json files will generate a well formatted page that contains an overview of the package. | In the jetpack-sdk/packages/<your module> directory, you can include a file called README.md. This file may contain some high level-level information about the package. The README.md and package.json files will generate a well formatted page that contains an overview of the package. | ||
[http://img.skitch.com/20100818-raumdbfmwytkf9qd26sg251a82.jpg | [http://img.skitch.com/20100818-raumdbfmwytkf9qd26sg251a82.jpg Documentation Example] | ||
Below the module on the left column is a list of the component modules, as built from the .js files in the jetpack-sdk/package/<your module>/lib directory. When you click on the name of the *lib*, the corresponding .md file in the docs directory is opened in the right column. | Below the module on the left column is a list of the component modules, as built from the .js files in the jetpack-sdk/package/<your module>/lib directory. When you click on the name of the *lib*, the corresponding .md file in the docs directory is opened in the right column. | ||