Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

Latest commit

 

History

History
401 lines (270 loc) · 11.4 KB

CHANGELOG.md

File metadata and controls

401 lines (270 loc) · 11.4 KB

4.7.0

Changed

  • page footer style has been synchronized with upstream 8deb882

4.6.1

Changed

  • bump overlayscrollbars to 2.4.7

Note

This will be the last release to update overlayscrollbars, which no longer supports IE.

4.6.0

Changed

  • static CSS is now minified by lightningcss
  • bump overlayscrollbars to 2.4.6

4.5.3

Changed

  • bump overlayscrollbars to 2.4.0
  • drop babel-preset-minify from dependencies
  • default object values are now displayed as plain text 6ab8efc

4.5.2

Changed

  • bump overlayscrollbars to 2.2.0

4.5.1

Added

  • sorting members by name is now optional 53ac387 (ported from upstream)

Fixed

  • parameter descriptions are now line-wrapped

4.5.0

BREAKING CHANGE

  • rename package to @clean-jsdoc/clean-jsdoc-es5

Added

  • displaying module names in top-level headings is now optional a132d0d (ported from upstream)

Fixed

  • the comma between source files and line references is now hyperlink style

4.4.0

Fixed

  • add a dependency on @jsdoc/salty for JSDoc v4 6178729

Changed

  • bump overlayscrollbars to 2.0.0

4.3.0

Fixed

  • prevent IE from wrapping list items 44d814e
  • enforce the background colour of the mobile hamburger button (circumvents a Firefox quirk) 0a4ef85

Changed

  • moved development of the IE-compatible version to a new LTS branch
  • multiple style improvements

4.2.2

Fixed

  • don't escape operators like & and > in source code pages 4cd6813
  • remove all CodePen markup from code examples when browsing in IE, and make the inline template scripts more backward-compatible 2a02216

Changed

  • bump overlayscrollbars to 1.13.2

4.2.1

Fixed

4.2.0

Added

  • new option to list only selected doc sections in the nav menu (ported from upstream)
  • new dynamic theme option: 453a2a3

Fixed

4.1.1

Fixed

  • remove unmatched </div> from @example template

4.1.0

Added

4.0.1

Fixed

4.0.0

BREAKING CHANGES

  • rename package so that releases can be pushed to the GitHub Package Registry directly from the default branch

    Note. Installing from the repo will work as before using the npm CLI, i.e.

      npm i rdipardo/clean-jsdoc-theme

    You should, however, update any dependent package.json:

    "devDependencies": {
-       "clean-jsdoc": "github:rdipardo/clean-jsdoc-theme",
+       "@rdipardo/clean-jsdoc": "github:rdipardo/clean-jsdoc-theme",

and change the template path in your .jsdoc.json:

        "opts": {
-       "template": "node_modules/clean-jsdoc",
+       "template": "node_modules/@rdipardo/clean-jsdoc",
  • drop options we don't intend to support, and give new names to the remaining options

Fixed

  • give sufficient padding to inline code quotations, even when inside <kbd> or <samp> tags
  • increase contrast of code quotations in both themes

3.0.2

Fixed

  • give <blockquotes> a visible background in the dark theme

Changed

README page

  • preserve numbers in ordered lists
  • make tables more discreet

3.0.1

Fixed

  • clean up names of "inner" module members in search results (publish.js) and parameter descriptions (tmpl/type.tmpl)
  • make the Properties subheading visible in tabular parameter descriptions
  • remove empty heading when a return value has no description
  • use consistent style for exceptions and fired events
  • make line numbers the same colour in both themes

3.0.0

Changed

2.5.1

Fixed

publish.js

  • remove invalid option from minifyOpts
  • correct file filter so that minify can actually process HTML
  • prevent legacy HTML from being invalidated by overly aggressive optimization

Changed

  • slightly better contrast in JSON syntax highlighting

2.5.0

Fixed

  • restore list style to <ul>s in README pages and make bullets solid to match with @see metadata

Changed

Added

  • recognize JSON syntax in code blocks

2.4.1

Fixed

  • keep the bottom margin consistent when plugins/markdown doesn't find a - after the @returns tag -- i.e., when the return value description is wrapped in <p> tags instead of <ul>s

2.4.0

Ported from upstream

Fixed

  • display @see metadata as a list
  • apply bold font weight to folded link lists as well as childless ones

Changed

  • use SEE ALSO as external link section heading

2.3.1

Fixed

  • prevent regex literals from matching with the division operator

2.3.0

Fixed

  • restore fs-extra dependency removed in last release
  • defer loading font-awesome assets until DOM is ready so that error-handler actually works

Changed

  • use the overlayscrollbars npm package
  • compile and minify all non-third-party scripts
  • minify all non-third-party static assets

Added

  • improve code prettifier with more keywords and smarter regex matching
  • give regex literals their own style rule

2.2.0

Fixed

  • render @example metadata with proper code block style

  • modify prettify.js to stop syntax highlighting in code blocks with the text file type so that markup like this:

    ```text

    npm i && npm i jsdoc --no-save

    ```

    looks like this:

    fixed_text_block

    and not like this:

    v2.1.0_text_block

Changed

  • make one default set of code style rules; keep some thematic variations for better contrast

2.1.0

Fixed

  • restore the dynamicStyle property that was accidentally removed from the layout template in the previous release
  • restrict the .pre-top-bar-container style to actual code blocks so that markup like this:
##Example

    /full/name/of/some/path

looks like this:

fixed_code_container

and not like this:

v2.0.0_code_container

2.0.0

Added

  • new features introduced upstream
  • the add_assets option will generate a link tag for stylesheets and image icons (so far) when only an href attribute is provided. Otherwise, it behaves the same as the (removed) add_style_path option

Changed

  • add_style_path

1.0.0

Fixed

  • use position: absolute; to keep the navigation toggle button inside the view-port on small mobile screens

Changed

  • versioning scheme is now independent of upstream

Added

  • provide fonts in .eot, svg, .woff and woff2 file formats
  • JS assets are now compiled to make them safe for IE 11

2.2.14.02

Fixed

  • the langNames option is now properly detected by the layout template
  • the demo/copy.cmd script works now

Changed

  • the nav bar's top margin is always dynamically set, with or without the search box present
  • show npm installation steps in the README

Added

  • special development scripts for Windows users

2.2.14.01

Fixed

  • only code is copied to the clipboard, with no extra HTML markup

Changed

  • use web-friendly Google fonts
  • tweak styles, layout

Added

  • new langNames option to hide language names from code blocks
  • new project option to display version and repo information

In version 2.2.14

Bug Fix

  1. Malformed HTML when parsing 'default' JSDoc tags [issue: #48]

In version 2.2.13

New

  1. Make the # before members and methods a clickable anchor. [pull request: #44] [Thanks to GMartigny]

Other

  1. Change jsdoc into a peerDependency [pull request: #45][Thanks to GMartigny]

In version 2.2.12

New

  1. Add dark theme.

Bug fix

  1. Fix typescript-eslint camelCase rule issue [issue: #37]
  2. Fix ordered list style [issue: #40]
  3. Fix code overflow issue.