YUIDoc theme for mdEditor, forked from yuidoc-ember-theme
npm install yuidoc-mdeditor-theme
An EmberJS based YUIDoc theme
``sh`
$ npm install yuidoc-mdeditor-theme
- This theme is to be used with ember-cli-yuidoc which uses
git-repo-version to generate the project version.
- This theme was originally forked from offirgolan/yuidoc-ember-theme
Use @category computed and @required
javascript`
/**
* A computed value
*
* @property something
* @type {Object}
* @category computed
* @required foo,bar
*/
$3
Use -- to represent /:
`javascript`
/**
* @class md-indicator--related
* @extend md-indicator
*/
$3
If your project uses a "yuidoc.json" file for configuration, add:
`js`
"themedir" : "node_modules/yuidoc-ember-theme",
"helpers" : ["node_modules/yuidoc-ember-theme/helpers/helpers.js"]
Example:
`json`
{
"name": "Example",
"url": "
"version": "0.1.0",
"indexModule": "Welcome",
"externalDocs": [{
"name": "ember-validators",
"path": "node_modules/ember-validators",
"url": "https://github.com/offirgolan/ember-validators",
"version": "master"
}],
"options": {
"paths": "_location to parse_",
"outdir": "build/docs",
"exclude": "lib,docs,build",
"themedir": "node_modules/yuidoc-ember-theme",
"helpers": ["node_modules/yuidoc-ember-theme/helpers/helpers.js"]
}
}
If indexModule is speficied in your yuidoc.json, the page will be forwarded to that module when a user loads the index page.
`json`
{
"indexModule": "Welcome"
}
If you have external documentation taken from dependencies, you may list them under the externalDocs option in your yuidoc.json. Doing so will setup the correct file names and paths.
`json``
{
"externalDocs": [{
"name": "ember-validators",
"path": "node_modules/ember-validators",
"url": "https://github.com/offirgolan/ember-validators",
"version": "master"
}]
}