Skip to content

1.5.0

Compare
Choose a tag to compare
@ShukantPal ShukantPal released this 06 Jun 20:05
· 72 commits to master since this release
640ee26

🎉 Feature(s)

  • Worker threads for indexing files in the parser (#126)

This cuts down webdoc's indexing time by 10-15% for mid-sized projects (~500-1000 files). It is disabled on small projects with less than ~50 files.

  • Publish source code in your documentation (#127)
    (enabled by default)
{
  "template": {
    "sources": true
  }
}
  • Analytics integration that supports Google Analytics and Plausible (#128)
{
  "template":  {
    "integrations": {
      "analytics": {
        "provider": "google-analytics",
        "trackingID": "UA-XXX-00"
      }
    }
  }
}
{
  "template":  {
    "integrations": {
      "analytics": {
        "provider": "plausible",
        "nakedDomain": "example.com"
      }
    }
  }
}
  • Alias for the tutorial template file in @webdoc/default-template (#129)

🗞️ Bug fixes

  • Fix parser errors when using TypeScript's parameter properties syntax (#130)

You can now use the following syntax:

class Tree {
  /** @param root */
  constructor(public readonly root: TreeNode) {

  }
}

The property root won't have a description, however. The parameter "root" of the constructor will do.