{"_id":"@cara/minami","_rev":"3-720427c949bf64cd431bc2a588810ce9","name":"@cara/minami","description":"Clean and minimal JSDoc 3 Template / Theme","dist-tags":{"latest":"1.2.3"},"versions":{"1.2.3":{"name":"@cara/minami","version":"1.2.3","description":"Clean and minimal JSDoc 3 Template / Theme","main":"publish.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/dotnil/minami.git"},"author":{"name":"Nijiko Yonskai","email":"nijikokun@gmail.com"},"licenses":[{"type":"Apache-2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}],"bugs":{"url":"https://github.com/dotnil/minami/issues"},"homepage":"https://github.com/dotnil/minami","gitHead":"0f353792c91be3f6050dcad4319726403a18bef1","_id":"@cara/minami@1.2.3","_npmVersion":"5.6.0","_nodeVersion":"8.9.1","_npmUser":{"name":"dotnil","email":"jakeplus@gmail.com"},"dist":{"integrity":"sha512-xusL8hT4f3Yv7eMd6KKMDh8/hx42KdJ1+HnXt1eBv022DyMJlDahAYk5q2fCV3J6cCzAbIyGuK6ZnYfF4xsWpg==","shasum":"0ed4db3ba18173f52fdb1d3903f8b5018bf04d52","tarball":"https://registry.npmjs.org/@cara/minami/-/minami-1.2.3.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFlU+QSTE/dQzdyO2Kiyo8v0tXWMtubc04ureOLbRSvcAiEAlmbxUwtevtBvclh4kP9kSlcZ5DGrmH85GMyDiJkdwic="}]},"maintainers":[{"name":"dotnil","email":"jakeplus@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/minami-1.2.3.tgz_1514286371607_0.5028208259027451"},"directories":{}}},"readme":"# Minami\n\nA clean, responsive documentation template theme for JSDoc 3.\n\n![Minami Screenshot](http://i.imgur.com/rPCIFqT.png)\n\n\n## Uses\n\n- [the Taffy Database library](http://taffydb.com/)\n- [Underscore Template library](http://underscorejs.org/#template)\n- [Montserrat](https://fonts.google.com/specimen/Montserrat) & Helvetica Neue\n\n\n## Install\n\n```bash\n$ npm install --save-dev minami\n```\n\n\n## Usage\n\nClone repository to your designated `jsdoc` template directory, then:\n\n```bash\n$ jsdoc entry-file.js -t path/to/minami\n```\n\n\n### Node.js Dependency\n\nIn your projects `package.json` file add a generate script:\n\n```json\n\"script\": {\n  \"generate-docs\": \"node_modules/.bin/jsdoc --configure .jsdoc.json --verbose\"\n}\n```\n\nIn your `.jsdoc.json` file, add a template option.\n\n```json\n\"opts\": {\n  \"template\": \"node_modules/minami\"\n}\n```\n\n\n### Example JSDoc Config\n\n```json\n{\n    \"tags\": {\n        \"allowUnknownTags\": true,\n        \"dictionaries\": [\"jsdoc\"]\n    },\n    \"source\": {\n        \"include\": [\"lib\", \"package.json\", \"README.md\"],\n        \"includePattern\": \".js$\",\n        \"excludePattern\": \"(node_modules/|docs)\"\n    },\n    \"plugins\": [\n        \"plugins/markdown\"\n    ],\n    \"templates\": {\n        \"cleverLinks\": false,\n        \"monospaceLinks\": true,\n        \"useLongnameInNav\": false,\n        \"showInheritedInNav\": true\n    },\n    \"opts\": {\n        \"destination\": \"./docs/\",\n        \"encoding\": \"utf8\",\n        \"private\": true,\n        \"recurse\": true,\n        \"template\": \"./node_modules/minami\"\n    }\n}\n```\n\nSpecifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).\n\n\n## License\n\nLicensed under the Apache2 license.\n","maintainers":[{"email":"814184517@qq.com","name":"shaozj"},{"email":"jakeplus@gmail.com","name":"dotnil"},{"email":"chenhui5416@gmail.com","name":"yiqian"}],"time":{"modified":"2022-04-04T21:47:17.899Z","created":"2017-12-26T11:06:11.672Z","1.2.3":"2017-12-26T11:06:11.672Z"},"homepage":"https://github.com/dotnil/minami","repository":{"type":"git","url":"git+https://github.com/dotnil/minami.git"},"author":{"name":"Nijiko Yonskai","email":"nijikokun@gmail.com"},"bugs":{"url":"https://github.com/dotnil/minami/issues"},"readmeFilename":"README.md"}