yuidoc-mdeditor-theme

    1.5.0 • Public • Published

    YUIDoc mdEditor Theme

    npm version

    An EmberJS based YUIDoc theme

    Live Example

    $ npm install yuidoc-mdeditor-theme

    Notes

    Extensions to the YUIDoc Features

    Computed properties

    Use @category computed and @required

    /**
    * A computed value
    *
    @property something
    @type {Object} 
    * @category computed
    @required foo,bar
    */   

    Class names with slashes

    Use -- to represent /:

    /**
    @class md-indicator--related
    * @extend md-indicator
    */ 

    Configuration File

    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"]

    Example:

    {
        "name": "Example",
        "url": "<GITHUB REPO 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"]
        }
    }

    Index Module

    If indexModule is speficied in your yuidoc.json, the page will be forwarded to that module when a user loads the index page.

    {
        "indexModule": "Welcome"
    }

    External Docs

    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.

    {
        "externalDocs": [{
            "name": "ember-validators",
            "path": "node_modules/ember-validators",
            "url": "https://github.com/offirgolan/ember-validators",
            "version": "master"
        }]
    }

    Install

    npm i yuidoc-mdeditor-theme

    DownloadsWeekly Downloads

    6

    Version

    1.5.0

    License

    none

    Unpacked Size

    1.85 MB

    Total Files

    52

    Last publish

    Collaborators

    • jlblcc