tidy-jsdoc

A minimalist and clean jsdoc template featuring custom styles via CSS variables and code syntax highlighting with Prism.js.

Challenge

Most jsdoc templates at the time were ugly, which limited usability for users and adoption of code documentation for authors.

Solution

Create an template with clear visual and information hierarchies to increase developer productivty.

Screenshots

Example: Newton Graph Library (tidy-jsdoc v1)
Example: Newton Graph Library (tidy-jsdoc v1)
Example Class Page (tidy-jsdoc v0.2)
Example Class Page (tidy-jsdoc v0.2)
Example Source Code Page (tidy-jsdoc v0.2)
Example Source Code Page (tidy-jsdoc v0.2)

Date

2021

URL

www.npmjs.com/package/tidy-jsdoc

Project Type

Tool

Skills

  • Design
  • JavaScript
  • JSDoc

Tagged

  • Open Source