Skip to content
This repository has been archived by the owner on Feb 23, 2023. It is now read-only.

Commit

Permalink
Removed demo, removed Grunt, simpler build process
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt Karl committed May 26, 2016
1 parent f423054 commit ca2c1f0
Show file tree
Hide file tree
Showing 19 changed files with 61 additions and 694 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
node_modules/
demo/dist/
static/**/jaguar.*
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/node_modules
/src
.gitignore
128 changes: 0 additions & 128 deletions Gruntfile.js

This file was deleted.

64 changes: 37 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
Jaguar.js template for JSDoc 3
---
- [Jaguar.js](http://davidshimjs.github.io/jaguarjs)
- [Jaguar.js Documentations](http://davidshimjs.github.io/jaguarjs/doc)
# Jaguar.js template for JSDoc 3

- [Jaguar.js](http://jaguarjs.com/)
- [Jaguar.js Documentations](http://jaguarjs.com/doc/)
- [JSDoc3](https://github.com/jsdoc3/jsdoc)
- [JSDoc3 API Documentations](http://usejsdoc.org)

Usage
---
1. If you want to create documentations with sample files, you can use commands below.
```
$ npm install
$ grunt demo
```
## Installation

2. You can see any output related jsdoc process with a `--debug` flag.
```
$ grunt demo --debug
```
Install the template using NPM:

3. If you already have jsdoc system, you can use this project as jsdoc template.
```
$ jsdoc -t `project folder` -c `configuration file` `source files` `README.md file`
```bash
npm install jaguarjs-jsdoc --save-dev
```

conf.json
---
You can set options for customizing your documentations.
## Usage

If you already have JSDoc system, you can use this project as JSDoc template. More information about JSDoc command-line arguments can be found [here](http://usejsdoc.org/about-commandline.html).

```bash
jsdoc -c conf.json -R README.md
```

### conf.json

You can set options for customizing your documentations. Notice the `"template"` field for setting the path to **jaguarjs-jsdoc**.

```json
"templates": {
"applicationName": "Demo",
"disqus": "",
Expand All @@ -44,13 +42,25 @@ You can set options for customizing your documentations.
"description": "",
"keyword": ""
},
"linenums": true
"linenums": true,
"source": {
"include": [
"./src/"
],
"includePattern": ".+\\.js(doc)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"opts": {
"encoding": "utf8",
"recurse": true,
"private": false,
"lenient": true,
"destination": "./docs",
"template": "./node_modules/jaguarjs-jsdoc"
}
}
```

License
---
This project under the MIT License. and this project refered by default template for JSDoc 3.

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/davidshimjs/jaguarjs-jsdoc/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
## License

This project under the MIT License. and this project refered by default template for JSDoc 3.
34 changes: 0 additions & 34 deletions conf.json

This file was deleted.

31 changes: 0 additions & 31 deletions demo/sample/Car.js

This file was deleted.

32 changes: 0 additions & 32 deletions demo/sample/Child.js

This file was deleted.

4 changes: 0 additions & 4 deletions demo/sample/Namespace.js

This file was deleted.

Loading

0 comments on commit ca2c1f0

Please sign in to comment.