diff --git a/README.md b/README.md index ae78fed..a13819b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ npm install @pixi/jsdoc-template --save-dev ## 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 ``` @@ -25,39 +25,45 @@ jsdoc -c conf.json -R README.md You can set options for customizing your documentations. Notice the `"template"` field for setting the path to **pixi-jsdoc-template**. ```json -"templates": { - "applicationName": "Demo", - "disqus": "", - "googleAnalytics": "", - "favicon": "path/to/favicon.png", - "openGraph": { - "title": "", - "type": "website", - "image": "", - "site_name": "", - "url": "" - }, - "meta": { - "title": "", - "description": "", - "keyword": "" - }, - "linenums": true, - "source": { - "include": [ - "./src/" - ], - "includePattern": ".+\\.js(doc)?$", - "excludePattern": "(^|\\/|\\\\)_" - }, - "opts": { - "encoding": "utf8", - "recurse": true, - "private": false, - "lenient": true, - "destination": "./docs", - "template": "./node_modules/@pixi/jsdoc-template" - } +{ + "templates": { + "applicationName": "Demo", + "disqus": "", + "googleAnalytics": "", + "favicon": "path/to/favicon.png", + "openGraph": { + "title": "", + "type": "website", + "image": "", + "site_name": "", + "url": "" + }, + "meta": { + "title": "", + "description": "", + "keyword": "" + }, + "linenums": true, + "source": { + "include": [ + "./src/" + ], + "includePattern": ".+\\.js(doc)?$", + "excludePattern": "(^|\\/|\\\\)_" + }, + "opts": { + "encoding": "utf8", + "recurse": true, + "private": false, + "lenient": true, + "destination": "./docs", + "template": "./node_modules/@pixi/jsdoc-template" + } + }, + "pixi": { + "styles": ["path/to/custom/styles.css"], + "scripts": ["path/to/custom/script.js"] + } } ``` diff --git a/tmpl/layout.tmpl b/tmpl/layout.tmpl index dad7e8e..06d12e1 100644 --- a/tmpl/layout.tmpl +++ b/tmpl/layout.tmpl @@ -31,7 +31,7 @@ - + + + + + + +