npm install jsdoc-rtd --save-dev
A readthedocs style jsdoc template. Forked from TUI JSDoc Template to inherit the extra navigation and search features. Mobile navigation styling applied from docdash template. Cleaned up to SCSS and ES6.
See the jsdoc configuration page for generic configaturion options.
"opts": {
"template": "node_modules/jsdoc-rtd"
}
"templates": {
"logo": {
"url": "http://url.to/image.png",
"width": "72px",
"height": "60px"
}
}
"templates": {
"name": "jsdoc template"
}
"templates": {
"footerText": "some text"
}
Default: true
"templates": {
"useCollapsibles": ture
}
"templates": {
"tabNames": {
"api": "API",
"tutorials": "Examples"
}
}
api defaults to the value API and tutorials defaults to the value Examples.
With a folder structure like this:
static
└── styles
└── custom.css
└── another.css
And a config like this:
"templates": {
"default": {
"staticFiles": {
"include": ["static/"]
}
},
"css": [
"styles/custom.css",
"styles/another.css",
"http://example.com/remote.css"
]
}
styles/custom.css, styles/another.css, and remote.css get included in the layout.
default.staticFiles is the build-in jsdoc way of copying extra files.
script.code-js tagdiv.code-html tag<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>example</title>
</head>
<body>
<div class="code-html">
<h3> Base Example </h3>
<p> Hello world </p>
</div>
<script class="code-js">
console.log('hello world');
</script>
</body>
</html>
FAQs
Readthedocs-style jsdoc template. Fork from TUI JSDoc template.
We found that jsdoc-rtd demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.