18.0.8 (2024-09-25)

Bug Fixes

• project: bump patch version (8845b9e)

18.0.4 (2024-09-24)

Bug Fixes

• add: add schematic adds incorrect layout (eb84266)
• builder: remove html-minifier vulnerability (a560471), closes #206

18.0.3 (2024-09-03)

Bug Fixes

• builder: categories with the same folder name merges into one (913af70), closes #204

18.0.2 (2024-08-26)

Bug Fixes

• app: page tabs overlap sidebar on mobile (ec2fe13)
• app: white glow on the sidebar when the dark theme is enabled on mobile (1127d1c)
• builder: missing entries in routes in CI/CD (92f706d)
• builder: the app does not update when pages are added or removed (6598ade)

18.0.1 (2024-08-23)

A special thanks to @eranshmil for helping with the release! ❤️

Builder

• Core Rewrite: The builder's core was rewritten to support multiple markdown files. chokidar was replaced with @parcel/watcher for faster response times to changes. The new builder is more modular, splitting into smaller builders, allowing only changed parts to be triggered. This improves cache performance by restoring data from the cache when only partial rebuilds are necessary.

General

• Syntax Highlighting: Replaced highlight.js with shiki, enhancing support for Angular inline template highlighting. This update affects the list of available languages and theme configuration.
• Mermaid Diagrams: Added support for Mermaid diagrams in markdown files. Use Mermaid syntax inside code blocks by specifying the mermaid language.
• Removed keyword Field: The keyword field was removed from the NgDocPage interface. Refer to the Migration Guide for more details.
• Multiple Markdown Files: The mdFile field now supports an array of paths, allowing multiple markdown files for a single doc page, which will be displayed as tabs.
• YAML Front Matter: You can now use YAML front matter syntax to specify title, icon, type, and keyword fields in markdown files, customizing tabs.
• Page Description: Descriptions for pages can now be specified using JSDoc comments, which will be displayed in the page header.
• Status Badges: Status badges for sidebar items can now be specified using the JSDoc @status tag. Customize the badge with color and text.
• Nested Types in Keywords: Added support for nested types in keywords, improving the readability of API types with complex inline code.
• Guide Header Templates: Added a headerTemplate property to guides configuration in ng-doc.config.ts, allowing customization of guide page headers.
• Various Fixes: Implemented various fixes to resolve interface glitches, improving hydration and overall app performance.
• Orama Search Update: Orama search engine updated to version 2.0.17.
• Signal Input Types: NgDocProcessorOptions now correctly infers the type of signal inputs.
• Blockquote Success Type: Added a success type for blockquotes.
• Keyword Loader: Angular keywords loader now creates link to angular.dev.

Schematics

• Auto-generated Keywords: The builder:page schematic now automatically generates a keyword for the page based on the title.

UI

• Design Update: Slightly updated the app's design.
• Reworked Search: Search functionality is now fullscreen and consistent across Desktop and Mobile.
• Navbar Inputs: leftContent, rightContent, and centerContent inputs were replaced with attribute selectors like ngDocNavbarLeft and ngDocNavbarRight in ng-doc-navbar. The centerContent input was removed.
• Image Viewer: Added an image viewer feature, making images in markdown files clickable and viewable in fullscreen mode.
• Sticky Demos: Demos in playgrounds are now sticky.
• Themes Update: The themes feature was changed to fix a glitch with SSR enabled. Now, themes should be defined in CSS/SCSS files and imported directly into style.css. Registration is no longer needed.
• Sidenav and Sidebar: Sidenav and sidebar APIs were updated to support hydration and SSR.
• Scrollable Tables: Tables are now scrollable if too wide, with the first column of API tables being sticky.
• Heading Anchors: Clicking on heading anchors now copies the anchor to the clipboard instead of navigating.
• API References: The API References page has been reworked.

API

• Selectors as Keywords: Component/Directive/Pipe selectors are now used as keywords by default, automatically converting to API links in inline code or HTML code blocks.
• JSDoc Tag Support: Added support for various JSDoc tags including @internal, @deprecated, @experimental, @alpha, and @beta.
• New NgDocApi Class: Introduced the NgDocApi class for displaying API info in guides, with methods like NgDocApi.api for generating API tables and NgDocApi.details for detailed API information.
• Function/Method Overloads: API now displays function and method overloads.
• New JSDoc Class: Added the JSDoc class for displaying JSDoc comments in guides, with methods for retrieving descriptions, tags, and checking for specific tags.

18.0.0-beta.2 (2024-08-23)

Bug Fixes

• project: package versions and various small bugs (1fefbd4)
• project: theme by default feature (5debaab)

18.0.0-beta.1 (2024-08-23)

Bug Fixes

• builder: fix build (9adcc8d)
• builder: fix build (8a1fa20)
• builder: fix build (68a1d1e)
• builder: fix migrations (0b1e58e)
• builder: fix migrations (56a7b1c)
• builder: fix migrations (5aeab32)
• builder: replace flex-controls with di-controls (465d62f)
• builder: replace flex-controls with di-controls (49cff30)
• builder: serveWebpackBrowser is not a function (a23dd2d)
• builder: test migration (da5afb5)
• builder: test migration (26bee5e)
• builder: the cache is not invalidated after removing .ng-doc folder (c20e479)
• keywords-loaders: fix release cycle for the keywords-loaders library (a1dbda9)
• ng-doc: ng-doc doesn't forget pages that have been moved to another directory (c433a10)
• ng-doc: release trigger (e7ac592)
• project: dependency injection error after update to 15.10.0 (cc41f44)
• project: fix "could not resolve path" error for the build target (66a7b23)
• semantic-release: bump version (d0f1862)

Features

• angular: bump Angular version (2945f16)
• angular: bump Angular version (47e3a24)
• angular: bump major version (446d203)
• builder: add additional migrations (c4a67d0)
• builder: add automatic migration (9c72508)
• builder: add automatic migration (dab72a0)
• ngDoc18 (144fb19)
• project: migrate to Angular 17 (5e7e36e)
• project: update packages (3542e64)

BREAKING CHANGES

• angular: bump major version
• API changes
• angular: Angular 17
• angular: Angular 17

17.6.16 (2024-07-18)

Bug Fixes

• builder: build failed after update to the latest Angular and NgDoc version (cd28db6), closes #192

17.6.15 (2024-07-17)

Bug Fixes

• builder: add support for Angular 18.1 (30365c7), closes #189

17.6.14 (2024-06-17)

Bug Fixes

• app: anchor scrolling doesn't work for Chinese and Cyrillic characters (5cb20e2), closes #172