Skip to content

Commit

Permalink
docs(config): normalize itee jsdoc config file
Browse files Browse the repository at this point in the history
  • Loading branch information
Itee committed Jul 21, 2021
1 parent 993d004 commit d2aa23a
Showing 1 changed file with 54 additions and 16 deletions.
70 changes: 54 additions & 16 deletions configs/jsdoc.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,62 @@
function CreateJsdocConfiguration () {

return {
'tags': {
'allowUnknownTags': false,
'dictionaries': [ 'jsdoc', 'closure' ]
tags: {
allowUnknownTags: false,
dictionaries: [ 'jsdoc', 'closure' ]
},
'source': {
'include': [],
'includePattern': '.+\\.js(doc|x)?$',
'excludePattern': '(node_modules|docs|builds|tests)'
source: {
include: [ 'README.md' ],
includePattern: '.+\\.js(doc|x)?$',
excludePattern: '(node_modules|docs|builds|tests)',
exclude: []
},
'sourceType': 'module',
'plugins': [],
'recurseDepth': 2,
'opts': {
'encoding': 'utf8',
'destination': './docs/',
'recurse': true,
'verbose': true,
'private': true
sourceType: 'module',
plugins: [],
recurseDepth: 5,
opts: {
access: 'all',
debug: false,
encoding: 'utf8',
destination: 'docs',
recurse: true,
verbose: true,
private: true
},
templates: {
cleverLinks: false,
monospaceLinks: false,
navType: 'inline',
theme: [
'cerulean',
'cosmo',
'darkly',
'cyborg',
'flatly',
'journal',
'lumen',
'paper',
'readable',
'sandstone',
'simplex',
'slate',
'spacelab',
'superhero',
'united',
'yeti'
][ 3 ],
syntaxTheme: 'dark',
linenums: true,
collapseSymbols: false,
sort: 'longname, version, since',
search: true,
systemName: 'Itee-LevelDB',
footer: '',
copyright: 'Copyright 2015-Present <a href="https://github.com/Itee">Itee</a> (Tristan Valcke)',
includeDate: false,
inverseNav: false,
outputSourceFiles: true,
outputSourcePath: true
}
}

Expand Down

0 comments on commit d2aa23a

Please sign in to comment.