agility-jsdoc-template
Advanced tools
Comparing version 1.0.0 to 1.0.1
{ | ||
"name": "agility-jsdoc-template", | ||
"version": "1.0.0", | ||
"description": "Clean and minimal JSDoc 3 Template / Theme", | ||
"version": "1.0.1", | ||
"description": "Clean and JSDoc 3 Template / Theme forked from the minimal template", | ||
"main": "publish.js", | ||
@@ -6,0 +6,0 @@ "scripts": { |
@@ -0,0 +0,0 @@ /*global env: true */ |
@@ -1,19 +0,10 @@ | ||
# Minami | ||
# Agility JsDoc Template | ||
A clean, responsive documentation template theme for JSDoc 3. | ||
![Minami Screenshot](http://i.imgur.com/rPCIFqT.png) | ||
## Uses | ||
- [the Taffy Database library](http://taffydb.com/) | ||
- [Underscore Template library](http://underscorejs.org/#template) | ||
- [Montserrat](https://fonts.google.com/specimen/Montserrat) & Helvetica Neue | ||
## Install | ||
```bash | ||
$ npm install --save-dev minami | ||
$ npm install --save-dev agility-jsdoc-template | ||
``` | ||
@@ -27,3 +18,3 @@ | ||
```bash | ||
$ jsdoc entry-file.js -t path/to/minami | ||
$ jsdoc entry-file.js -t path/to/agility-jsdoc-template | ||
``` | ||
@@ -46,3 +37,3 @@ | ||
"opts": { | ||
"template": "node_modules/minami" | ||
"template": "node_modules/agility-jsdoc-template" | ||
} | ||
@@ -56,8 +47,4 @@ ``` | ||
{ | ||
"tags": { | ||
"allowUnknownTags": true, | ||
"dictionaries": ["jsdoc"] | ||
}, | ||
"source": { | ||
"include": ["lib", "package.json", "README.md"], | ||
"include": ["src", "README.md", "package.json"], | ||
"includePattern": ".js$", | ||
@@ -69,14 +56,20 @@ "excludePattern": "(node_modules/|docs)" | ||
], | ||
"recurse": 10, | ||
"templates": { | ||
"cleverLinks": false, | ||
"monospaceLinks": true, | ||
"useLongnameInNav": false, | ||
"useLongnameInNav": true, | ||
"showInheritedInNav": true | ||
}, | ||
"tags": { | ||
"allowUnknownTags": true, | ||
"dictionaries": ["jsdoc"] | ||
}, | ||
"source-type": "module", | ||
"opts": { | ||
"destination": "./docs/", | ||
"encoding": "utf8", | ||
"private": true, | ||
"private": false, | ||
"recurse": true, | ||
"template": "./node_modules/minami" | ||
"template": "./node_modules/agility-jsdoc-template" | ||
} | ||
@@ -83,0 +76,0 @@ } |
@@ -0,0 +0,0 @@ /*global document */ |
@@ -0,0 +0,0 @@ |
PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n"]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", | ||
/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); |
@@ -0,0 +0,0 @@ var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1478430
81