Skip to content

v5.0.3

Choose a tag to compare

@ankitskvmdam ankitskvmdam released this 23 Jun 04:25
3a419de

Patch release with bug fixes and a TypeDoc parity feature.

Bug fixes

  • index name clash (#333) — a documented symbol named index no longer overwrites the home page. It now renders at /index/ like any other container, so neither page is lost.
  • Hardened MDX brace escaping (#333) — inline-code detection now follows CommonMark (a code span can't cross a blank line), so a single unbalanced inline-code backtick in one doc comment can no longer desync escaping across a whole aggregated page (e.g. Globals) and abort it with "Could not parse expression with acorn".
  • Sidebar on tablet/iPad — on widths where both the left sidebar and the mobile table-of-contents bar show, the sidebar's first item is no longer hidden behind the TOC bar.

Improvements

  • Render diagnostics (#333) — when a page fails to compile, the build now reports the exact line:column plus a code-frame snippet instead of just the slug, so the offending content is easy to locate on large pages.
  • Unbalanced-backtick warnings (#333) — unbalanced inline-code backticks are surfaced as non-fatal build warnings pointing at the source line, so the authoring slip is easy to find and fix.

TypeDoc

  • docs prose directory (#334) — the TypeDoc plugin now supports the docs option (plus docGroups / defaultDocGroup), matching the JSDoc bridge: hand-written Markdown/HTML guides render alongside the API. (readme remains TypeDoc's own top-level option.)

Docs: https://ankdev.me/clean-jsdoc-theme/