Skip to content

Commit 5e51138

Browse files
committed
First push
0 parents  commit 5e51138

26 files changed

+2640
-0
lines changed

LICENSE.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# License
2+
3+
Docdash 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) 2016 Clement Moron <[email protected]> and the
8+
[contributors to docdash](https://github.com/clenemt/docdash/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 docdash is available at:
27+
https://github.com/clenemt/docdash
28+
29+
# Third-Party Software
30+
31+
Docdash 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-2016 Michael Mathews <[email protected]> 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

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Docdash
2+
3+
[![npm](https://img.shields.io/npm/v/docdash.svg)](docdash on npm) [![npm](https://img.shields.io/npm/l/docdash.svg)](license MIT)
4+
5+
A clean, responsive documentation template theme for JSDoc 3.
6+
7+
![docdash-screenshot](https://cloud.githubusercontent.com/assets/447956/13398144/4dde7f36-defd-11e5-8909-1a9013302cb9.png)
8+
9+
![docdash-screenshot-2](https://cloud.githubusercontent.com/assets/447956/13401057/e30effd8-df0a-11e5-9f51-66257ac38e94.jpg)
10+
11+
## Install
12+
13+
```bash
14+
$ npm install --save-dev docdash
15+
```
16+
17+
## Simple usage with cli
18+
19+
Clone repository to your designated `jsdoc` template directory, then:
20+
21+
```bash
22+
$ jsdoc entry-file.js -t path/to/docdash
23+
```
24+
25+
## Usage with build process
26+
27+
In your projects `package.json` file add a generate script:
28+
29+
```json
30+
"script": {
31+
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json"
32+
}
33+
```
34+
35+
In your `.jsdoc.json` file, add a template option.
36+
37+
```json
38+
"opts": {
39+
"template": "node_modules/dodash"
40+
}
41+
```
42+
43+
## Sample `.jsdoc.json`
44+
45+
```json
46+
{
47+
"tags": {
48+
"allowUnknownTags": false
49+
},
50+
"source": {
51+
"include": "../js",
52+
"includePattern": ".js$",
53+
"excludePattern": "(node_modules/|docs)"
54+
},
55+
"plugins": [
56+
"plugins/markdown"
57+
],
58+
"opts": {
59+
"template": "assets/template/minami-master/",
60+
"encoding": "utf8",
61+
"destination": "docs/",
62+
"recurse": true,
63+
"verbose": true
64+
},
65+
"templates": {
66+
"cleverLinks": false,
67+
"monospaceLinks": false
68+
}
69+
}
70+
```
71+
72+
## Thanks
73+
74+
Thanks to [lodash](https://lodash.com/docs) and [minami](https://github.com/nijikokun/minami).
75+
76+
## License
77+
78+
Licensed under the Apache2 license. (see [license](LICENSE.md)).

package.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "docdash",
3+
"version": "0.1.0",
4+
"description": "A clean, responsive documentation template theme for JSDoc 3 inspired by lodash and minami",
5+
"main": "publish.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/clenemt/docdash.git"
12+
},
13+
"author": "Clement Moron <[email protected]>",
14+
"license": "MIT",
15+
"keywords": [
16+
"jsdoc",
17+
"template"
18+
]
19+
}

0 commit comments

Comments
 (0)