2.1.1

Fixed 🐛

• Fixed misplaced HTML body tag (4a699de) @ShukantPal

2.1.0

Added 🎁

• Faster page reloads and offline storage option in the default template. A service worker was added that has a sophisticated cache and can cache the entire site on demand. Your users can enable offline storage in the settings to view documentation when they are not connected to the Internet. (#190, #191) @ShukantPal

The service worker will let users know if they are offline or if the cache has been updated:

Fixed (🐛)

• Fixed issue with class signatures having redundant extends, implements keywords (#189) @ShukantPal

2.0.0

Added 🎁

• Neat little highlighting of the current item in the right-side members explorer (#187) @ShukantPal

Screen.Recording.2022-07-16.at.7.28.11.PM.mov

Fixes 🐛

• Fixed issue where an arrow function documented with @method with no parameters could cause a crash (#184) @ShukantPal
• Fixed issue with filename collisions when 2 symbols have the same name with different cases (#183) @ShukantPal
• Improvement to left-side explorer highlighting when index.html is excluded from the URL

2.0.0-beta

2.0.0-beta

webdoc has transitioned to The Prosperity Public License, which restricts usage to noncommercial purposes. A commercial license is available on demand at [email protected]!

Added 🎁

• webdoc's parser is now split up into @webdoc/language-* packages and the language library package is available to create new language integrations.
• webdoc init can be used to create a new configuration file and the configuration file has a JSON schema for type auto-complete (#87) @ShukantPal

Fixes 🐛

• Fixed issue with Class Index links (#172) @ShukantPal
• Fixed issue with stylesheet routes (#176) @ShukantPal

1.6.5

Added 🎁

• @webdoc/default-template's theme has been tweaked to make it much more readable - with larger fonts and more whitespace. It also now uses system fonts (#173) @ShukantPal
• webdoc now supports mermaid diagrams in markdown. You can use mermaid-style diagrams in your API documentation, tutorials, and even READMEs.

```mermaid
flowchart TD
A --> B
```

• The @group tag can be used to groups classes and other documents in the explorer. This is useful if you have super large packages. Using the @group tag does not change your API hierarchy in webdoc's model, and is just an aestheic change in the template.

/** @group Alphabet */
class A {}

/** @group Alphabet */
class B {}

Fixed

• @webdoc/default-template's watermark "Powered by webdoc!" has now been moved out of the footer and into it's own element. The footer can now be customized without having to add attribution to webdoc.

1.6.3

Bug 🐛

• Fixed issue with custom img html "src" attributes not being properly resolved when --site-root is passed (#171) @ShukantPal

1.6.2

Added 🎁

• Highlighted example source code (#168) @ShukantPal
• GitHub source links integration in @webdoc/default-template (#169) @ShukantPal
• Add support for template.assets option to copy over assets and use <img src=""> tags, experimentally (#170) @ShukantPal

1.6.1

Added 🎁

• Added property table for class members in @webdoc/default-template (#156) @ShukantPal
• Added parameters / returns table for standalone function pages in @webdoc/default-template (#161) @ShukantPal

Fixed 🐛

• Fixed standalone @function documentation comments not generating symbols (#167) @ShukantPal
• Fixed string literal keys being used to assign properties in objects not being documented (#160) @ShukantPal

1.6.0

🎁 Added

• Adds the --quiet command line argument. This suppresses all warning logs and outputs only errors. It's the opposite of --verbose, which takes precedence over it.
• Add support for object pattern parameters. This means you can document functions that look as follows:

/**
 * Calculates the distance between the points "a", "b".
 *
 * @param {number} .a.x - A's x-coordinate
 * @param {number} .a.y - A's y-coordinate
 * @param {number} .b.x - B's x-coordinate
 * @param {number} .b.y - B's y-coordinate
 */
function distance({ a: { x: x0, y: y0 }, b: { x: x1, y: y1 }) {
}

🐛 Fixed

• Added source code location for some parser errors

1.5.5

🎁 Added

• Support for type parameters (#141)

🐛 Fixes

• Fix issue with @ignore tag not pruning all ignored documents (#142)