{
  "name": "docdash",
  "version": "0.4.0",
  "description": "A clean, responsive documentation template theme for JSDoc 3 inspired by lodash and minami",
  "main": "publish.js",
  "scripts": {
    "test": "jsdoc -c fixtures/fixtures.conf.json",
    "sync": "browser-sync start -s ../fixtures-doc -f ../fixtures-doc --reload-delay 1000 --no-ui --no-notify",
    "watch": "watch-run -d 1000 -p tmpl/**,static/** \"npm run test\""
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/clenemt/docdash.git"
  },
  "devDependencies": {
    "jsdoc": "latest",
    "browser-sync": "latest",
    "watch-run": "latest"
  },
  "author": {
    "name": "Clement Moron",
    "email": "clement.moron@gmail.com"
  },
  "license": "Apache-2.0",
  "keywords": [
    "jsdoc",
    "template"
  ],
  "readme": "# Docdash\r\n[![npm package](https://img.shields.io/npm/v/docdash.svg)](https://www.npmjs.com/package/docdash) [![license](https://img.shields.io/npm/l/docdash.svg)](LICENSE.md)\r\n\r\nA clean, responsive documentation template theme for JSDoc 3.\r\n\r\n![docdash-screenshot](https://cloud.githubusercontent.com/assets/447956/13398144/4dde7f36-defd-11e5-8909-1a9013302cb9.png)\r\n\r\n![docdash-screenshot-2](https://cloud.githubusercontent.com/assets/447956/13401057/e30effd8-df0a-11e5-9f51-66257ac38e94.jpg)\r\n\r\n## Example\r\nSee http://clenemt.github.io/docdash/ for a sample demo. :rocket:\r\n\r\n## Install\r\n\r\n```bash\r\n$ npm install docdash\r\n```\r\n\r\n## Usage\r\nClone repository to your designated `jsdoc` template directory, then:\r\n\r\n```bash\r\n$ jsdoc entry-file.js -t path/to/docdash\r\n```\r\n\r\n## Usage (npm)\r\nIn your projects `package.json` file add a new script:\r\n\r\n```json\r\n\"script\": {\r\n  \"generate-docs\": \"node_modules/.bin/jsdoc -c jsdoc.json\"\r\n}\r\n```\r\n\r\nIn your `jsdoc.json` file, add a template option.\r\n\r\n```json\r\n\"opts\": {\r\n  \"template\": \"node_modules/docdash\"\r\n}\r\n```\r\n\r\n## Sample `jsdoc.json`\r\nSee the config file for the [fixtures](fixtures/fixtures.conf.json) or the sample below.\r\n\r\n```json\r\n{\r\n    \"tags\": {\r\n        \"allowUnknownTags\": false\r\n    },\r\n    \"source\": {\r\n        \"include\": \"../js\",\r\n        \"includePattern\": \".js$\",\r\n        \"excludePattern\": \"(node_modules/|docs)\"\r\n    },\r\n    \"plugins\": [\r\n        \"plugins/markdown\"\r\n    ],\r\n    \"opts\": {\r\n        \"template\": \"assets/template/docdash/\",\r\n        \"encoding\": \"utf8\",\r\n        \"destination\": \"docs/\",\r\n        \"recurse\": true,\r\n        \"verbose\": true\r\n    },\r\n    \"templates\": {\r\n        \"cleverLinks\": false,\r\n        \"monospaceLinks\": false\r\n    }\r\n}\r\n```\r\n\r\n## Options\r\nDocdash supports the following options:\r\n\r\n```json\r\n{\r\n    \"docdash\": {\r\n        \"static\": [false|true],  // Display the static members inside the navbar\r\n        \"sort\": [false|true]     // Sort the methods in the navbar\r\n    }\r\n}\r\n```\r\n\r\nPlace them anywhere inside your `jsdoc.json` file.\r\n\r\n## Thanks\r\nThanks to [lodash](https://lodash.com) and [minami](https://github.com/nijikokun/minami).\r\n\r\n## License\r\nLicensed under the Apache License, version 2.0. (see [Apache-2.0](LICENSE.md)).\r\n",
  "readmeFilename": "README.md",
  "bugs": {
    "url": "https://github.com/clenemt/docdash/issues"
  },
  "_id": "docdash@0.4.0",
  "_from": "docdash@0.4.0"
}