npm install hopsdocjsdoc theme for hops
Forked from this theme
Here's a a List of Projects that use this theme:
- hopsdoc documentation (this project)
- hops documentation (originally made for this project)

``bash`
$ npm install --save-dev hopsdoc
Clone repository to your designated jsdoc template directory, then:
`bash`
$ jsdoc entry-file.js -t path/to/hopsdocbuild this theme
This theme uses default underscore templates (<% instead of )
and has a script to transform in both directions. This way your code editor can highlight the code correctly.
files in tmpl are not commited and should not be modified. The tmpl folder is generated and used as npm export. tmpl
If you want to convert your "custom delimiter theme" to make it compatible to this project you can replace the folder and generate your development version.
> Warning !!! generating a dev version from another template will remove the original theme entirely.
> As long as you don't modify the content inside the tmpl folder you don't have to worry about
> accidently running the wrong command.
`bash`generate custom delimiter version
npm run _to-customgenerate default delimiter version
npm run _from-customgenerate custom delimiter version and build styles
npm run build
`bash.static/styles/*.scss
cp node_modules/hopsdoc ./path/to/my/custom/theme
cd ./path/to/my/custom/theme/hopsdoc
npm install
npm run watch-stylesor ...
modify styles in
`then ...
npm run styles
In your projects package.json file add a generate script:
`json`
"script": {
"generate-docs": "jsdoc -c .jsdoc.json"
}
In your .jsdoc.json file, add a template option.
`json`
"opts": {
"template": "node_modules/hopsdoc"
}
`json``
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": ["src", "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/hopsdoc"
}
}
Licensed under the Apache2 license.