modern-jsdoc-template

Modern JSDoc default template

Modern JSDoc default template with a Dark/Light theme style that closely resembles the Dark/Light theme found on GitHub

Demo

Table of contents

• Why?
• Goal
• Features
• Comparison Table
• Quick start
• Contributing
• Changelog
• Thanks

Why?

Dark/Light theme

This template enhances the simple and minimalistic JSDoc default template by incorporating a dark and light theme styling, similar to GitHub's dark dimmed and light theme. There are no other significant alterations.

Goal

Minimal changes to the default theme.

The JSDoc default theme has undergone minimal changes. The template only includes new styles and slight external script additions to the JSDoc default template. The main functionality and features remain unchanged. During the build process, most of the templates are copied from JSDoc without any modifications, ensuring alignment with the JSDoc default template in terms of features and functionality.

Features:

• Dark/Light theme similar to GitHub light and dark dimmed themes
• Highlight.js as a code syntax highlighter instead of prettify.js
• Table of contents based on tocbot.js
• initial.css as a base root CSS styling

Comparison Table

	JSDoc default template	Modern JSDoc template
Publish Script	publish.js	publish.js (no changes, same as in JSDoc default template)
Code syntax highlighter script	prettify.js(self-hosted)	highlight.js (CDN)
Code line numbers script	linenumber.js (self-hosted)	highlightjs-line-numbers.js (CDN)
General CSS styling	JSDoc default	Dark/Light theme (similar to GitHub)
Code syntax highlighter styles	JSDoc prettify.js theme	Dark/Light theme (similar to GitHub)
Layout Template	JSDoc default layout	JSDoc default layout with some modifications to add scripts and styles
All others templates	JSDoc default	Same as in JSDoc default, no changes!
Fonts	OpenSans (external)	system fonts
Table of contents	no	yes

Quick start

• Install jsdoc

npm install --save-dev jsdoc

• Install modern-jsdoc-template

npm install --save-dev modern-jsdoc-template

• Specify a source and template in jsdoc.json

{
  "plugins": ["plugins/markdown"],
  "source": {
    "include": ["source???/"]
  },
  "templates": {
    "cleverLinks": true,
    "default": {
      "includeDate": false
    }
  },
  "opts": {
    "template": "node_modules/modern-jsdoc-template/default",
    "readme": "./README.md",
    "destination": "./docs/",
    "recurse": true,
    "verbose": true
  },
  "markdown": {
    "idInHeadings": true
  }
}

• Generate documentation

npx jsdoc -c jsdoc.json

Contributing

• Clone/fork the repository and run npm install to install dependencies.
• Run npm start to start the development server with watcher.
• Add your changes to src/* files and test the result in browser on http://localhost:8082
• Run npm test to run tests.
• Commit your changes and create a pull request.

Thanks

• JSDoc
• Highlight.js
• highlightjs-line-numbers.js
• Tocbot
• GitHub dark/light theme
• initial.css

Changelog

v1.0.0 June 10, 2023

• [BUGFIX] add files config for npm package (c32cfac)
• [TASK] add homepage, issues and git url to package.json (8f55c43)