dylanfoster / yuidoc-parch-theme

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

YUIDoc Parch Theme

npm version

An YUIDoc theme based on yuidoc-ember-theme

$ npm install yuidoc-parch-theme

Configuration File

If your project uses a "yuidoc.json" file for configuration, add:

"themedir" : "node_modules/yuidoc-parch-theme",
"helpers" : ["node_modules/yuidoc-parch-theme/helpers/helpers.js"]

Example:

{
  "name": "Example",
  "url": "<GITHUB REPO URL>",
  "version": "0.1.0",
  "indexModule": "Welcome",
  "options": {
      "paths": "_location to parse_",
      "outdir": "docs",
      "exclude": "lib,docs",
      "themedir": "node_modules/yuidoc-parch-theme",
      "helpers": ["node_modules/yuidoc-parch-theme/helpers/helpers.js"]
  }
}

About

License:MIT License


Languages

Language:HTML 51.9%Language:CSS 40.7%Language:JavaScript 7.4%