https://github.com/smeijer/latodoc
jsDoc3 Theme
https://github.com/smeijer/latodoc
Last synced: about 1 month ago
JSON representation
jsDoc3 Theme
- Host: GitHub
- URL: https://github.com/smeijer/latodoc
- Owner: smeijer
- License: mit
- Created: 2015-04-05T17:30:33.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T19:53:48.000Z (12 months ago)
- Last Synced: 2025-03-17T21:42:19.575Z (about 2 months ago)
- Language: JavaScript
- Size: 141 KB
- Stars: 18
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LatoDoc
A clean, responsive documentation template theme for JSDoc 3.
## Uses
- [the Taffy Database library](http://taffydb.com/)
- [Underscore Template library](http://documentcloud.github.com/underscore/#template)
- [Lato](https://www.google.com/fonts/specimen/Lato)
- [Source Code Pro](https://www.google.com/fonts/specimen/Source+Code+Pro)
## Install
```bash
$ npm install --save-dev smeijer/latodoc
```
## Usage
Clone repository to your designated `jsdoc` template directory, then:
```bash
$ jsdoc entry-file.js -t path/to/latodoc
```
### Node.js Dependency
In your projects `package.json` file add a generate script:
```json
"script": {
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}
```
In your `.jsdoc.json` file, add a template option.
```json
"opts": {
"template": "node_modules/latodoc"
}
```
### Example JSDoc Config
```json
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": ["lib", "package.json", "README.md"],
"includePattern": "\\.js$",
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"templates": {
"cleverLinks": true,
"monospaceLinks": true
},
"opts": {
"destination": "./docs/",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "./node_modules/latodoc"
}
}
```
## License
Licensed under the MIT license.