加入CODE CHINA

· 不限速    · 不限空间    · 不限人数    · 私仓免费

免费加入
README.md

Jaguar.js template for JSDoc 3

Usage

  1. If you want to create documentations with sample files, you can use commands below.
$ npm install
$ grunt demo
  1. You can see any output related jsdoc process with a --debug flag.
$ grunt demo --debug
  1. 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`

conf.json

You can set options for customizing your documentations.

"templates": {
    "applicationName": "Demo",
    "disqus": "",
    "googleAnalytics": "",
    "openGraph": {
        "title": "",
        "type": "website",
        "image": "",
        "site_name": "",
        "url": ""
    },
    "meta": {
        "title": "",
        "description": "",
        "keyword": ""
    },
    "linenums": true
}

License

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

Bitdeli Badge

项目简介

🚀 Github 镜像仓库 🚀

源项目地址

https://github.com/davidshimjs/jaguarjs-jsdoc

发行版本

当前项目没有发行版本

贡献者 6

S Sangmin, Shim @Sangmin, Shim
T Tom Wiesing @Tom Wiesing
V Vincent Meurisse @Vincent Meurisse
B benwick @benwick
D David, Shim @David, Shim
B Bitdeli Chef @Bitdeli Chef

开发语言

  • JavaScript 56.4 %
  • CSS 43.6 %