YUIDoc mdEditor Theme
An EmberJS based YUIDoc theme
$ 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
Extensions to the YUIDoc Features
@category computed and
/*** A computed value** @property something* @type* @category computed* @required foo,bar*/
Class names with slashes
-- to represent
/*** @class md-indicator--related* @extend md-indicator*/
If your project uses a "yuidoc.json" file for configuration, add:
"themedir" : "node_modules/yuidoc-ember-theme""helpers" : "node_modules/yuidoc-ember-theme/helpers/helpers.js"
indexModule is speficied in your yuidoc.json, the page will be forwarded to that module when a user loads the index page.
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.