Skip to content

Commit e4236c7

Browse files
updated the example file
2 parents 9a23829 + fb9e490 commit e4236c7

72 files changed

Lines changed: 17399 additions & 2 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

LICENSE.txt

100644100755
File mode changed.

contentstack-templates/LICENSE

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# License
2+
3+
Minami is free software, licensed under the Apache License, Version 2.0 (the
4+
"License"). Commercial and non-commercial use are permitted in compliance with
5+
the License.
6+
7+
Copyright (c) 2014-2015 Nijiko Yonskai <nijikokun@gmail.com> and the
8+
[contributors to Minami](https://github.com/Nijikokun/minami/graphs/contributors).
9+
All rights reserved.
10+
11+
You may obtain a copy of the License at:
12+
http://www.apache.org/licenses/LICENSE-2.0
13+
14+
In addition, a copy of the License is included with this distribution.
15+
16+
As stated in Section 7, "Disclaimer of Warranty," of the License:
17+
18+
> Licensor provides the Work (and each Contributor provides its Contributions)
19+
> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
20+
> express or implied, including, without limitation, any warranties or
21+
> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
22+
> PARTICULAR PURPOSE. You are solely responsible for determining the
23+
> appropriateness of using or redistributing the Work and assume any risks
24+
> associated with Your exercise of permissions under this License.
25+
26+
The source code for JSDoc 3 is available at:
27+
https://github.com/Nijikokun/minami
28+
29+
# Third-Party Software
30+
31+
Minami includes or depends upon the following third-party software, either in
32+
whole or in part. Each third-party software package is provided under its own
33+
license.
34+
35+
## JSDoc 3
36+
37+
JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
38+
"License"). Commercial and non-commercial use are permitted in compliance with
39+
the License.
40+
41+
Copyright (c) 2011-2015 Michael Mathews <micmath@gmail.com> and the
42+
[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
43+
All rights reserved.
44+
45+
You may obtain a copy of the License at:
46+
http://www.apache.org/licenses/LICENSE-2.0
47+
48+
In addition, a copy of the License is included with this distribution.
49+
50+
As stated in Section 7, "Disclaimer of Warranty," of the License:
51+
52+
> Licensor provides the Work (and each Contributor provides its Contributions)
53+
> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
54+
> express or implied, including, without limitation, any warranties or
55+
> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
56+
> PARTICULAR PURPOSE. You are solely responsible for determining the
57+
> appropriateness of using or redistributing the Work and assume any risks
58+
> associated with Your exercise of permissions under this License.
59+
60+
The source code for JSDoc 3 is available at:
61+
https://github.com/jsdoc3/jsdoc

contentstack-templates/README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Minami
2+
3+
A clean, responsive documentation template theme for JSDoc 3.
4+
5+
![Minami Screenshot](http://puu.sh/gOyNe/66c3adcb97.png)
6+
7+
## Uses
8+
9+
- [the Taffy Database library](http://taffydb.com/)
10+
- [Underscore Template library](http://documentcloud.github.com/underscore/#template)
11+
- [Montserrat](http://www.google.com/fonts/specimen/Monsterrat) & Helvetica Neue
12+
13+
## Install
14+
15+
```bash
16+
$ npm install --save-dev minami
17+
```
18+
19+
## Usage
20+
21+
Clone repository to your designated `jsdoc` template directory, then:
22+
23+
```bash
24+
$ jsdoc entry-file.js -t path/to/minami
25+
```
26+
27+
### Node.js Dependency
28+
29+
In your projects `package.json` file add a generate script:
30+
31+
```json
32+
"script": {
33+
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
34+
}
35+
```
36+
37+
In your `.jsdoc.json` file, add a template option.
38+
39+
```json
40+
"opts": {
41+
"template": "node_modules/minami"
42+
}
43+
```
44+
45+
### Example JSDoc Config
46+
47+
```json
48+
{
49+
"tags": {
50+
"allowUnknownTags": true,
51+
"dictionaries": ["jsdoc"]
52+
},
53+
"source": {
54+
"include": ["lib", "package.json", "README.md"],
55+
"includePattern": ".js$",
56+
"excludePattern": "(node_modules/|docs)"
57+
},
58+
"plugins": [
59+
"plugins/markdown"
60+
],
61+
"templates": {
62+
"cleverLinks": false,
63+
"monospaceLinks": true
64+
},
65+
"opts": {
66+
"destination": "./docs/",
67+
"encoding": "utf8",
68+
"private": true,
69+
"recurse": true,
70+
"template": "./node_modules/minami"
71+
}
72+
}
73+
```
74+
75+
## License
76+
77+
Licensed under the Apache2 license.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"name": "minami",
3+
"version": "1.1.1",
4+
"description": "Clean and minimal JSDoc 3 Template / Theme",
5+
"main": "publish.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "git+https://github.com/Nijikokun/minami.git"
12+
},
13+
"author": {
14+
"name": "Nijiko Yonskai",
15+
"email": "nijikokun@gmail.com"
16+
},
17+
"licenses": [
18+
{
19+
"type": "Apache-2.0",
20+
"url": "http://www.apache.org/licenses/LICENSE-2.0"
21+
}
22+
],
23+
"bugs": {
24+
"url": "https://github.com/Nijikokun/minami/issues"
25+
},
26+
"homepage": "https://github.com/Nijikokun/minami",
27+
"gitHead": "afae369e61aeec0e909cf8c53c374ce26f4ffb85",
28+
"_id": "minami@1.1.1",
29+
"_shasum": "11e33c46f5fff6d391085e17df9a5e4a761f9dfc",
30+
"_from": "minami@*",
31+
"_npmVersion": "2.9.1",
32+
"_nodeVersion": "0.12.3",
33+
"_npmUser": {
34+
"name": "nijikokun",
35+
"email": "nijikokun@gmail.com"
36+
},
37+
"maintainers": [
38+
{
39+
"name": "nijikokun",
40+
"email": "nijikokun@gmail.com"
41+
}
42+
],
43+
"dist": {
44+
"shasum": "11e33c46f5fff6d391085e17df9a5e4a761f9dfc",
45+
"tarball": "http://registry.npmjs.org/minami/-/minami-1.1.1.tgz"
46+
},
47+
"directories": {},
48+
"_resolved": "https://registry.npmjs.org/minami/-/minami-1.1.1.tgz"
49+
}

0 commit comments

Comments
 (0)