Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/magnatronus/sa.duckandcover
Titanium Studio JSDuck plug-in extension
https://github.com/magnatronus/sa.duckandcover
Last synced: about 2 months ago
JSON representation
Titanium Studio JSDuck plug-in extension
- Host: GitHub
- URL: https://github.com/magnatronus/sa.duckandcover
- Owner: magnatronus
- License: apache-2.0
- Created: 2014-07-30T14:18:45.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-25T08:17:14.000Z (almost 10 years ago)
- Last Synced: 2024-07-30T04:57:40.793Z (about 2 months ago)
- Language: JavaScript
- Size: 157 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DuckAndCover Introduction
**sa.duckandcover** is a Titanium Studio plugin that can be used to auto generate Alloy project documentation with JSDuck.
There is also an example TiAlloy project [here on GitHub](https://github.com/magnatronus/testdocumentor) that shows the use of the plug-in.
## Prerequisites
JSDuck should be installed. Please see [https://github.com/senchalabs/jsduck](https://github.com/senchalabs/jsduck) for more details.
## Installation
copy the *sa.duckandcover* directory into the **plugins** directory of your Alloy project then enable it by adding the following to the tiapp.xml file.
before enabling sa.duckandcover
```
ti.alloy
```
after enabling the plugin
```
ti.alloy
sa.duckandcover
```
## Configuration
### Output directory
The default output directory specified in *sa.duckandcover* is the *docs* directory in the project root. This is defined in the plugin code here
```
//change this to specify where the docs will be generated
var doc_output_dir = '/docs';
```
by changing the variable *doc_output_dir* you can modify where the documentation is generated.
### Configuration options
All files mention in the configuration section should be placed in the root directory of the project to be included in the documentation process.
As installed *sa.duckandcover* will generate default JSDuck documentation, but if other files are detected then the documentation can be enhanced.
#### Welcome Page
If the project has a **README.md** this will be added to the documentation as the welcome page (by default there is no welcome page).
#### Guides
If a **jsduck-guides.json** file exists then it will be picked up and used to add the defined guides to the documentation. See [https://github.com/senchalabs/jsduck/wiki/Guides](https://github.com/senchalabs/jsduck/wiki/Guides) for more details.
#### Categories
When a **jsduck-categories.json** file is detected it is used in the generation of the documentation. See [https://github.com/senchalabs/jsduck/wiki/Categories](https://github.com/senchalabs/jsduck/wiki/Categories) for more information on JSDuck categories.
## Credits
- Apperson Labs - http://appersonlabs.com/2013/04/12/titanium-build-plugins-in-sdk-3-x-x/
- Ronald Treur on TiDev (http://www.tidev.io/2014/05/14/duckumentation/)
- Fokke Zandbergen on TiDev (http://www.tidev.io/2014/06/18/documenting-a-new-widget/)