19.2.0 (2025-04-20)
Bug Fixes
- add: automatic project configuration doesn't work (111965c), closes #273
- items inside collapsed expander were clickable (#271) (7a30f0f)
- status tag visible in description (#270) (bc764fa), closes #269
Features
- properties tables for Type Alias Declarations (#261) (aa3b658), closes #259
19.1.0 (2024-12-23)
Bug Fixes
- app: mermaid has no text inside shapes (#254) (6eef471), closes #253
- builder: at-rule (@) should not be evaluated inside code block (cb4cd1e), closes #232
- builder: multi-line param documentation doesn't display correctly (1300b07), closes #240
- builder: playground doesn't show values for user controls (7185dc5), closes #235
- builder: specifying API Reference Page route Causing Asset Not Found (dac0b6d), closes #236
Features
- app: make collapsed sidebar links SEO-friendly (3217d5a)
- builder: add a call signatures support for interfaces API (e132eaa), closes #238
19.0.1 (2024-12-09)
Bug Fixes
- builder: isStandalone helper does not work with Angular new default value (6ed4afe), closes #252
- builder: isStandalone helper does not work with Angular new default value (71af521), closes #252
19.0.0 (2024-12-08)
Features
- angular: bump major version (34aa025)
BREAKING CHANGES
- angular: Angular 19 dependency
18.5.0 (2024-12-08)
Features
- angular: bump major version (c094454)
18.4.0 (2024-12-08)
Bug Fixes
- project: lock angular version for the
add package (bd7202d)
Features
- angular: add support for Angular 19 (ab392d4), closes #247
18.3.1 (2024-11-26)
Bug Fixes
- project: lock angular version to avoid dependency conflicts (173063e)
18.3.0 (2024-10-14)
Features
- builder: added support for gitlab repos (#231) (39b20db)
18.2.0 (2024-10-06)
Bug Fixes
- project: single quote in page title breaks a build (040b9b7), closes #223
- update @parcel/watcher version (#225) (c7f5717), closes #222
Features
- builder: add support for
[@example](https://github.com/example) tag (#229) (5d7440f), closes #221
- builder: add support for
[@remarks](https://github.com/remarks) tag (#220) (7958769), closes #218
- builder: add support for
[@returns](https://github.com/returns) tag (#228) (8dd4fd1), closes #219
18.1.1 (2024-10-01)
Bug Fixes
- project: bump patch version to fix NPM release (196d237)
18.1.0 (2024-09-30)
Bug Fixes
- app: resolving properly anchor links when using base-href (#217) (005c575), closes #216
- keywords-loader: adjust ng-keywords-loader to different api manifest structure (#211) (d9dc0aa), closes #210
Features
- keywords-loader: add rxjs keywords loader (#209) (d96da81)
18.0.9 (2024-09-29)
Bug Fixes
- app: treat links with
mailto: prefix as external (#215) (23d7dee), closes #194
18.0.8 (2024-09-25)
Bug Fixes
- project: bump patch version (8845b9e)
18.0.7 (2024-09-24)
Bug Fixes
- project: bump patch version (937cc28)
18.0.6 (2024-09-24)
Bug Fixes
- project: bump patch version (11a3173)
18.0.5 (2024-09-24)
Bug Fixes
- builder: generated folder is empty if a project doesn't contain pages (4030683)
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)
Bug Fixes
- project: bump patch version (073384a)
18.0.0 (2024-08-23)
Bug Fixes
- project: package versions and various small bugs (1fefbd4)
- project: sync package-lock.json (39098d9)
- project: theme by default feature (5debaab)
Features
BREAKING CHANGES
- angular: bump major version
- API changes
Bug Fixes
- builder: build failed after update to the latest Angular and NgDoc version (cd28db6), closes #192
Bug Fixes
- builder: add support for Angular 18.1 (30365c7), closes #189
Bug Fixes
- app: anchor scrolling doesn't work for Chinese and Cyrillic characters (5cb20e2), closes #172
Bug Fixes
- ng-add: undefined project in assets and tsconfig paths (#160) (df214a3), closes #115
Bug Fixes
- allows customizing the title of the API page (#170) (0bc22b5)
Bug Fixes
- app: home icon in breadcrumb has invalid path (8a9bb7e), closes #167
Bug Fixes
- builder: cannot read properties of undefined (reading 'relative') (42506f5)
17.6.9 (2024-05-27)
Bug Fixes
- app: category imports break a build for Angular 17.3 and above (e4163d4)
17.6.8 (2024-05-08)
Bug Fixes
- app: table of contents link does not work properly with
baseHref (f65fc1f), closes #159
17.6.7 (2024-05-03)
Bug Fixes
- builder: setting
hidden: true for the page doesn't have an effect (6cf9aaa), closes #158
17.6.6 (2024-05-01)
Bug Fixes
- builder: eliminate dev-server schema validation error (#153) (68a9039), closes #147
17.6.5 (2024-04-30)
Bug Fixes
- builder: playground templates do not support direct input directive binding (e.g.,
<img [ngDocRotator]="true"/>) (ab8bcb2)
17.6.4 (2024-04-27)
Bug Fixes
- builder: builder doesn't ignore inputs used for the component in the playground template (75c89d0), closes #156
17.6.3 (2024-04-24)
Bug Fixes
- app: input aliasing selector renders in playground template using property name (d7cf81e), closes #155
17.6.2 (2024-04-22)
Bug Fixes
- builder: imports in generated APIs lead to a build error for latest angular version (1b4bdf6)
17.6.1 (2024-04-17)
Bug Fixes
- builder: imports in
ng-doc.routing.ts lead to a build error for latest angular version (61effbf), closes #154
17.6.0 (2024-04-14)
Features
- ui: nunito font was removed, now UI uses system fonts by default (32d3e11), closes #152
17.5.7 (2024-04-08)
Bug Fixes
- builder: builder configuration doesn't support .js extension (94773ac), closes #148
17.5.6 (2024-04-03)
Bug Fixes
- builder: playgrounds break the build for the Angular 17.3 version (54e8711), closes #144
17.5.5 (2024-03-06)
Bug Fixes
- demo: demos don't extract code from the new
styleUrl property (b8061f0), closes #140
- playgrounds: recreating playground's demos doesn't work (9b4bdb7), closes #138
17.5.4 (2024-03-03)
Bug Fixes
- builder: input signals that have
undefined in type are not displayed in playgrounds (07dd7f6), closes #137
17.5.3 (2024-03-02)
Bug Fixes
- builder: builder doesnt format the code if application uses prettier >=2.x.x (4df1eda), closes #136
17.5.2 (2024-02-27)
Bug Fixes
- app: search icon is not displayed in the navbar for mobile and tablet views (dcd3d6d)
17.5.1 (2024-02-21)
Bug Fixes
- builder: multiple API Configurations causes build error (3389546), closes #133
17.5.0 (2024-02-17)
Features
- builder: add
inputs property for demo and demoPane actions (21a80cd), closes #132
17.4.0 (2024-02-16)
Features
- builder: add
excludeByTsDocsTags function to filter out nodes based on TS documentation tags (#131) (2a55f57)
17.3.2 (2024-02-15)
Bug Fixes
- ui-kit: checkbox always displays checked state (5f752fe)
- ui-kit: remove redundant input in button component (f0335dd)
17.3.1 (2024-02-13)
Bug Fixes
- builder: add missed name options in schemas (#130) (f35ed2c)
17.3.0 (2024-01-18)
Features
17.2.3 (2024-01-12)
Bug Fixes
- ui-kit: update @ngneat/until-destroy dependency (e2d1d5c), closes #127
17.2.2 (2024-01-07)
Bug Fixes
- app: table of content is not displayed (f08373d)
17.2.1 (2023-12-27)
Bug Fixes
- add: add schematics don't add HttpClient provider by default (1dccda3)
17.2.0 (2023-12-18)
Features
17.1.3 (2023-12-01)
Bug Fixes
- app: inputs with type
string display model incorrectly (948dae6)
- builder: playgrounds don't support
@Input accessors (d5c12c8), closes #116
- core: playground fails with errors for some specific input types (1ec8668)
17.1.2 (2023-11-21)
Bug Fixes
- add: automatic installation of the library does not add the default layout (544c66a)
17.1.1 (2023-11-21)
Bug Fixes
- add: automatic installation of the library does not add the default layout (3c10464)
17.1.0 (2023-11-21)
Bug Fixes
- add: imports of default modules in some cases are added to the wrong file (50f691a)
- add: migration and adding ng-doc leads to warnings (7cfe6d6)
- ui-kit: fix
Continuous Integration
BREAKING CHANGES
18.0.0 (2023-11-21)
Bug Fixes
- add: imports of default modules in some cases are added to the wrong file (50f691a)
- add: migration and adding ng-doc leads to warnings (7cfe6d6)
- ui-kit: fix
Continuous Integration
BREAKING CHANGES
17.0.0 (2023-11-20)
Continuous Integration
BREAKING CHANGES
Features
Features
- core,app: can disable fullscreen routes in the page configuration (0e31089), closes #106
Bug Fixes
- app: theme service throws warning if light theme is selected by default (f6ca077)
Features
- project: add fullscreen mode for demos (c557f17), closes #84
- builder: builder no longer writes files to disk if their content hasn't changed, which slightly speeds up the application rebuild process (5a80548)
Bug Fixes
- app: playgrounds for pipes display changed inputs in demo's template in wrong order (fb51e9d)
- app: playgrounds for pipes don't display default values for inputs in the production (4f2a271)
- app: toc throws an error if page has no headings (77334e5)
Features
- app: add
alert blockquote type (fbd607a)
- app: blockquotes were redesigned (64a8577)
- app: design has been updated, and now the elements better complement each other and are easier to customize (96f540d)
- app: theme service has been improved, now you can enable or disable auto theming using
NgDocThemeService, or define your own themes for auto theming (5e7959f)
- playground: playground displays "Reset" button only if form is changed (5d13545)
BREAKING CHANGES
- app: The CSS color palette variables
--ng-doc-<color>-<shade> have been removed because they were redundant
and mostly cluttered the CSS
Bug Fixes
- app: dark-purple theme was removed (fb9cffe)
- app: styles from ng-doc affect other components (270eafd)
- builder: builder crashes with an error when trying to load files on Windows (d564c84), closes #102
Features
- app: code blocks and code block groups were redesigned (a228922)
BREAKING CHANGES
- app:
dark-purple theme was removed
Bug Fixes
- processor: add
provideMainPageProcessor function (ca3cd76)
Bug Fixes
- add: schematic doesn't import
NgDocRootComponent component (c07b389)
- add: schematic doesn't provide
provideNgDocApp configuration (6d698d7)
- builder: ESM page compilation (#100) (3a4b36a)
Features
- project: page layout components (page navigation, breadcrumbs, table of content) can be replaced with your own. Project was converted to standalone (#101) (d7aad28), closes #88 #66
- styles: change margin of various page blocks to improve spacing and readability, add
--ng-doc-page-block-margin variable that can be used to change it globally (1441f89)
BREAKING CHANGES
- project: All modules were removed, you should use provider
functions instead. Please read the "Migration" article to know more.
Bug Fixes
- builder: app cannot be built if some of the playground properties imports entity from Angular package (dc57891), closes #99
Bug Fixes
- project: providers inside a component is not recognized in playgrounds (26705a6), closes #96
Features
- playgrounds: add
controls property to playgrounds to define inputs that NgDoc doesn't recognize, and hiddenInputs to hide specific inputs in the playground (1cdcca9), closes #97
Bug Fixes
- project: providers inside a component is not recognized in playgrounds (fcf8298), closes #96
Bug Fixes
- playgrounds: the component created in the playground with the set values of
defaults or inputs receives undefined in the ngOnChanges hook for the set inputs (2b21918)
- schematics: schematics incorrectly import parent category on Windows (59293ee)
Features
- builder: add support for
ng-doc-ignore-line comment to remove some lines of code from demo or code blocks (#93) (8b668b2), closes #83
- builder: add support for
Route interface for the route property of the page configuration (#94) (65c1bd7), closes #89
- builder: add support for loading snippets from files (f8889db)
- builder: add support for query parameters for the keywords (#95) (d0da419), closes #86
- builder: add support for the keywords for the API configuration (4166685)
- demo: the snippets have been reworked and their syntax has been changed also new features have been added, such as icons, language switching, etc. The previous syntax is still supported, but it is recommended to migrate to the new one (#92) (2cc98cf)
Bug Fixes
- app:
search and `menu icons are missed for the mobile view (886e1ae)
- schematics:
order property in generate category has a string type (b5aa730)
Features
- builder: add ability to set different ng-doc configuration files for different build targets (bb0c8d0)
16.9.0 (2023-07-08)
Features
- ui-kit: add icons support for code blocks and code block groups (687b4cc)
- ui-kit: add the ability to add custom icons to the documentation (30c4012)
- ui-kit: remove all unused icon from
ui-kit library (8b01fec)
16.8.1 (2023-07-07)
Bug Fixes
- playgrounds: playground does not display inputs defined in parent classes (#81) (31b882a)
16.8.0 (2023-07-07)
Bug Fixes
- schematics: using slashes in the
title leads to changing the final directory where the generated file will be placed (1436ff9)
Features
- page-processors: page processor is now a public API and can be used for dynamically creating components within pages, check documentation for more details (8f98d6e)
- playgrounds: add more opportunities to configure playgrounds, making them more dynamic and reusable (#80) (cc661fb)
- project: configuration format simplification for all NgDoc files like
ng-doc.page.ts, ng-doc.category.ts, ng-doc.api.ts and ng-doc.config.ts. Please read migrations article to know how to migrate to the new conifg format (e12f4a4), closes #75
- schematics: add
--name flag for page and category schematics that can be used to provide variable name (4188b7b), closes #75
16.7.2 (2023-07-05)
Bug Fixes
- builder: playgrounds do not dynamically update the list of inputs when the
dev-server is running, and used class is included in the API list (d25a410)
- playgrounds: playgrounds do not recognize dynamic default values, such as the result of a function call or a value from a constructor variable (dd5381b), closes #76
- ui-kit: the text of the tabs overlaps with the overlay created by the sidebar (d66f649)
- utils: keywords used in the inline code are processed not as a whole, but by attempting to find occurrences (024f43f)
16.7.1 (2023-07-03)
Bug Fixes
- builder: generated links for the accessors via keywords have incorrect label (da70a1b)
- builder: some code presentations or files that were loaded to the code blocks have empty line at the end (7382b73)
16.7.0 (2023-07-02)
Bug Fixes
- builder: code blocks parameters don't support some characters (b91d26f)
- builder: code blocks parameters don't support some characters (77a989c)
Features
- project: code blocks can now be grouped using tabs (f9d2ef1)
- project: code blocks can now be grouped using tabs (11c0ed1)
16.6.6 (2023-07-01)
Bug Fixes
- builder: fix tests (0aca03c)
- builder: generated files via schematics have some miss alignments (062cb0d)
- builder: schematics don't work in the root folder of the repository (2caeef6), closes #71
- builder: some symbols in the page and category titles cause a built error (d230811), closes #73
16.6.5 (2023-06-26)
Bug Fixes
- project: add schematic fails on brand new angular 16.1 app (a6dd29d), closes #69
16.6.4 (2023-06-24)
Bug Fixes
- builder: parsimmon package is not installed after adding ng-doc to the project (b5a030b)
16.6.3 (2023-06-21)
Bug Fixes
- builder: build gets stuck if there are no file entities (388eda0), closes #67
16.6.2 (2023-06-21)
Bug Fixes
- builder: playgrounds autogeneration does not support Angular 16 required inputs (c36a348), closes #68
- keywords-loaders: remove warning about experimental fetch method (9c72b0b)
16.6.1 (2023-06-14)
Bug Fixes
- app: the code block is not displayed correctly in playgrounds (a0e6d92)
16.6.0 (2023-06-14)
Bug Fixes
- app: decorators in API pages are displayed without a gap (e697bd0)
Features
- app: the copy button in the code block is now visible only when you hover the cursor (18fae7e)
- builder: add lines highlighter. You can use this feature to highlight any line of code inside your code blocks (66bd91f)
- builder: add option to change the output folder for the documentation application (4069b47), closes #65
- builder: builder adds lines to the code blocks (c3cefcb)
16.5.1 (2023-06-09)
Bug Fixes
- builder: config loader requires
swc packages (7a4b06a)
16.5.0 (2023-06-09)
Bug Fixes
- builder: anchor is removed for external links (f0a62b4)
- builder: application
build command doesn't exit (cf83777), closes #64
- builder: builder doesn't collect exported declarations from barrel files (553291c)
- builder: builder doesn't rebuild page after changes if it was restored from cache (295e3ee)
- builder: entities with errors or warnings are cached (57a4648)
- builder: the cache is not invalidated after removing
.ng-doc folder (7ccc0be), closes #58
- builder: the delay of the tooltip before opening has been increased to 1 second (bfc67cc)
Features
- app: external links now display the special icon (ebc7b46)
- builder: add
keywordLoaders to the builder configuration file that allows you to specify async loaders for global keywords (1ef5f74)
- project: add
ngDocKeywordsLoader to integrate your documentation with third-party documentation that was created with NgDoc (6968045)
- project: add
ngKeywordsLoader to integrate your documentation with the Angular documentation (a0d3863)
- app:
js-beautify library was replaces with esthetic library, which reduces the bundle size and improves html formatting for playgrounds (bb17556)
- core: remove
rxjs dependency that affects the bundle size (2368a00)
16.4.3 (2023-06-07)
Bug Fixes
- builder: application
build command doesn't exit (7928134), closes #64
16.4.2 (2023-06-06)
Bug Fixes
- app: playgrounds break with an injector error when creating (2edf223)
16.4.1 (2023-06-06)
Bug Fixes
- app: playgrounds can't find type controls (953a08b)
16.4.0 (2023-06-06)
Features
- builder: builder and error/warning output have been improved, now the builder is more stable and it's easier to understand where you are haveing problems (#61) (7d11c79)
- project: add support for directives and pipes to playgrounds (#62) (28b0930), closes #60
- project: now you can specify the anchors for the keywords that can create a link to the page's section or API member (#63) (a16d5d4), closes #2
16.3.6 (2023-06-02)
Bug Fixes
- project: minimatch has wrong version in dependencies (d271d02)
16.3.5 (2023-06-01)
Bug Fixes
- builder: builder doesn't see file changes on Windows machines (673bf83)
- builder: builder doesn't see file changes on Windows machines (e82a7cc)
16.3.4 (2023-05-30)
Bug Fixes
- builder: add
@angular/cdk to the dependencies of the ui-kit package (9fb07e6)
- builder: disable
cache feature by default as it is unstable for the production (89a04dc)
- builder: playground doesn't update inputs based on source code changes in development mode (f9a5966)
16.3.3 (2023-05-30)
Bug Fixes
- builder: playground doesn`t change components inputs in production if production target builds application from dist folder (3fd3060)
16.3.2 (2023-05-29)
Bug Fixes
- builder: update
@orama/* packages to the stable ones (7a3159f)
- builder: update version of
rxjs dependency which will install the latest version of tslib (16fde16)
16.3.1 (2023-05-29)
Bug Fixes
- app: some icons are not displayed (689b194)
16.3.0 (2023-05-29)
Bug Fixes
- builder: add missing dependencies (cf7d42a)
Features
- project: pages now are standalone, which means you can import/register Angular dependencies in the page itself and if you use standalone components, you don't need to import anything! Please see migration guide to know how to migrate (#57)! (#56) (21e6c17), closes #42 #52
16.2.1 (2023-05-26)
Bug Fixes
- builder: the builder throws an error if the demo code has certain javascript characters (cf86d3b)
16.2.0 (2023-05-25)
Features
- builder: cache is here! Now NgDoc caches build results and next time it will use them or rebuild only necessary pages instead of rebuilding everything from scratch (83a6caa), closes #44
16.1.1 (2023-05-21)
Bug Fixes
- core: playgrounds cannot import
formatHtml function dynamically (e58b5ea)
16.1.0 (2023-05-21)
Bug Fixes
- app:
arrow-up, arrow-down hotkeys don't work for the search input (ea58bd5)
- app: browser console has various warnings (a41927e)
Features
- builder: add experimental esbuild support, now you can configure the builder by specifying
angularBuilder property in the ng-doc.config.ts file (57f40a2), closes #42
- builder: external packages now can be provided in the configuration file, to make them available in your code for file entities (4f0c1b2)
- builder: the current state of the build is now displayed in the console (#49) (9e8f4bf)
- app:
@orama/* packages that are using for search have been updated, resulting in a reduced size of the main bundle. However, now it is necessary to manually import the stemmer from @orama/stemmers for languages other than English (8a0f69c)
16.0.2 (2023-05-10)
Bug Fixes
- app: footer is not at the bottom of the page if its content is smaller than the screen height (ec5b768)
16.0.1 (2023-05-09)
Bug Fixes
16.0.0 (2023-05-09)
Bug Fixes
- app: api list filter is too small on mobile devices (c1d7668)
- app: search doesn't work in
ES2022 projects (dec2325)
Features
- app: update angular dependencies (c4e1da6)
- project: angular 16 support (f785944)
- project: angular 16 support (3b4f6d4), closes #43
BREAKING CHANGES
Bug Fixes
- app: long bread crumbs do not break correctly on a new line (386911a)
- builder: links based on keywords are not created for code examples in demos (ca9480d)
- builder: update
nunjucks package version to fix vulnerability (6d8066a)
Features
- app: you can provide
auto as the defaultTheme and the theme will be selected automatically based on the user's OS settings (1f55720)
- layout: sidebar and root component were improved, now you can customize or disable some features (e7692f3)
Features
- playgrounds: the controls used in playgrounds are now sorted primarily by type and then by name, which should make playgrounds pretty. It is now also possible to specify the order for custom type controls (009f462)
- builder: the Entity API search for exported declarations has been optimized, now it is twice as fast. For ng-doc documentation, it used to take 6 - 7 seconds, now ~3 seconds (0d905c4)
Bug Fixes
- builder: ng-doc throws an error "CodeBlockWriter is not a constructor" during development (52aee4a)
Bug Fixes
- project: dependency versions are not locked (c4e2d59), closes #41
Bug Fixes
- builder: keywords links are not created for code blocks with
ts extension (aa97451)
Bug Fixes
- app: headings in not indexable content have a wrong margin (82dbea1)
- builder: ng-doc throws an error if a page was removed from the file system (515e8b7)
Features
- builder: now ng-doc handles several API configuration files correctly (ab84513), closes #26
- builder: enable the "noEmit" property for the NgDoc TypeScript project, this should slightly improve performance for the projects with a lot of API entities (f06a75d)
Bug Fixes
- builder: default param value displayed as [object Object] in API presentations (30fb08b), closes #40
Bug Fixes
- builder: api doesn't display
undefined for optional types if strict mode is enabled (1a812a2)
- builder: remove unused duplicate of
NgDocPageIndex interface (8c65331)
- utils: html post processor doesn't wrap the html with the body tag anymore (6118a7e)
Bug Fixes
- builder: logical types are not recognized correctly in playground (e062357)
- builder: some types are not displayed in the API (f9e3885)
Bug Fixes
- builder: logical types are not recognized correctly in playground (16c348c)
Bug Fixes
- builder: builder emits error if there are API nodes without type (ee67112)
Bug Fixes
- app: nested
ul list are displayed with wrong margin (4b7ae6b)
- builder: inline code is lost in indexes (7157dc0)
- builder: ng-doc expands type aliases for API (86ca3ab)
- builder: ng-doc truncates long literal types (f1581fd)
- p: iframes are not styled (ce4379c)
- project: dependency injection error after update to 15.10.0 (5ca03a1)
- search: fix
@oramasearch/orama warnings and add HTML sanitizer (378d8aa)
Features
- add: ng-add command provides
NgDocSearchEngine automatically (af535c4)
- app: add a spinner to the search component to indicate when the search is in progress (d35c4e8)
- app: add animation of content changes for tabs and code tooltips (5fec4ab)
- app: add breadcrumbs for guides (931fd86)
- app: code blocks use
--ng-doc-code-background CSS variable (75f4d8a)
- app: copy to clipboard button now changes its text if code was copied (f71f7c4)
- app: search component and search engine improvements (d865e26), closes #31
- builder: add
demoPane method to display demo (3ce3e32)
- builder: content indexing can be disabled for certain blocks (43ebeaa)
- builder: markdown code blocks improvements (32aa365)
- builder: now all API presentation are formatted by default (a7108e8)
- utils: add new
@ng-doc/utils package that now contains Post HTML Processor (0d44b5a)
- builder: improve the indexing process (02857e2)
15.9.0 (2023-03-26)
Bug Fixes
app: code blocks have wrong font config([8a8b172] (https://github.com/skoropadas/ng-doc/commit/8a8b17205050f360619f4aebc6a6931aa1336acc))
Features
app: conditionally remove docs page from sidebar([5f52ab8] (https://github.com/skoropadas/ng-doc/commit/5f52ab8006876434a2e3133e07e688283e68964e)), closes#35
15.8.0 (2023-03-23)
Bug Fixes
app: headings don't display anchor icon on hover([167b15a] (https://github.com/skoropadas/ng-doc/commit/167b15afb54d84037dc28ce4e90e79130d23f4e7))
Features
add: add schematics adds default RouterModule config automatically to allow scroll repositions when link anchor was clicked([2698781] (https://github.com/skoropadas/ng-doc/commit/269878102a513cfc2778ad1d1c45e6a935e234ed))
Bug Fixes
app:
navigation links in code examples do not work when using baseHref(12280d0), closes#34
Bug Fixes
app:
navigation links do not work when using baseHref(41f4c3f), closes#34
Bug Fixes
**app:**navigation links do not work when using baseHref([81a0847](https://github.com/skoropadas/ng-doc/commit/81a08479a69df1524b268063c92e0ec8c8e67aba))
15.7.9 (2023-03-19)
Bug Fixes
**builder:**new demo code previews are unavailable until the application is restarted([038e0ef](https://github.com/skoropadas/ng-doc/commit/038e0ef79ca650f55ff00536ff93c5416ca64d8b)), closes[#33](https://github.com/skoropadas/ng-doc/issues/33)
15.7.8 (2023-03-17)
Bug Fixes
- add: schematic doesnt add NgDoc modules (dcee2ae)
- builder: if an error is made in the template syntax, the application throws an error and stops building, while if the error is fixed, you still have to restart the build (81f7b70)
15.7.7 (2023-03-13)
Bug Fixes
- builder: replace
ts-node config loader with swc (b0df84f)
- builder: update builder imports (a4ef8c3)
15.7.6 (2023-03-13)
Bug Fixes
- builder: replace
ts-node config loader with swc (f279818)
15.7.5 (2023-03-13)
Bug Fixes
- app: next page button is aligned to the left if there is no previous page (017560b)
- app: playground's type controls are not provided (458ab4a)
- builder: add
Page suffix for page schematic (88b92d3)
15.7.4 (2023-03-12)
Bug Fixes
- add:
add command adds deprecated configuration (dbaf75b)
- add: path error, if
ngDoc configuration in angular.json is not provided (03a57ad)
- app: global CSS styles leak into component demos (f8d615a), closes #28
15.7.3 (2023-03-08)
Bug Fixes
- app: global CSS styles leak into component demos (1ab364d), closes #28
15.7.2 (2023-03-08)
Bug Fixes
- app: some dependencies are not installed (0c57d6c), closes #30
Reverts
- Revert "fix(app): global CSS styles leak into component demos" (a1d9bb9)
15.7.1 (2023-03-07)
Bug Fixes
- app: ng-doc does not use the
tsConfig passed in the global configuration (3dfd5cc)
15.7.0 (2023-03-07)
Bug Fixes
- app: filter for entity type on the api list page doesn't display type icons (eeb8bdd)
- app: global CSS styles leak into component demos (91727f5), closes #28
- app: prev/next links are wrong for pages with similar routes (3cdf42a), closes #29
- app: remove warning about
beautify-html library (714f3c7)
- builder:
onlyForTags property of the page/category configuration object should contain project configuration name like production or development (9aebc99)
Features
- app:
toc is generated based on headers with id given header level (96cd9e2)
- app: add
anchorHeadings to the NgDocConfiguration interface, that can be used to limit the headings for which anchor links should be generated (10aaa20), closes #27
- app: filter by entity name on the api list page is focused by default (865d0a4)
- app: replace
ngDoc configuration field in angular.json with ng-doc.config.js file (e2c9b6c), closes #20
15.6.0 (2023-03-03)
Bug Fixes
- app: missing dependency js-beautify (fa1a8e3), closes #22
- builder: api scopes are not sorted by
order field (b07598c)
- builder: paths are generated incorrectly on Windows (9cbda4c), closes #25
Features
- app: add
scope filter for api list (911196c), closes #23
15.5.1 (2023-03-01)
Bug Fixes
- app: previous page button display on the right side of the page (b32d978)
- app: previous/next buttons have wrong background color for dark themes (90bf376)
15.5.0 (2023-03-01)
Features
- app: add "Previous/Next Page" links to guide pages (01bd3fd), closes #19
- app: display protected keyword (56b8f4c), closes #13
- ui-kit: add more types of button (7708737)
15.4.1 (2023-02-26)
- app: add minification for HTML files (c51ad6d)
- app: remove unused languages imports for highlight.js (ab93672)
- builder: change imports from
@ng-doc/core (44b949c)
- builder: reduce delays (12a8fcf)
- builder: replace
prettier with js-beautify to reduce bundle size (da688e5)
15.4.0 (2023-02-24)
Features
- app: add dark purple theme (fce107f)
- app: add more options to configure
demo action (2ce8826), closes #16
15.3.2 (2023-02-20)
Bug Fixes
- builder: types to some properties are defined as any (5bc231c)
15.3.1 (2023-02-20)
Bug Fixes
- project: push a stuck release (c66a867)
15.3.0 (2023-02-20)
Features
- app: add
NgDocCustomNavbarDirective, NgDocCustomSidebarDirective for custom components (f5ae230)
- project: add playground feature (f750580), closes #12
15.2.0 (2023-02-10)
Features
- app: add glass effect to the header (0833db3)
- app: entities in the api list are sorted by type and name (c2ae928)
- ui-kit: add
NgDocScrollService that allows to block document scroll (e644459)
15.1.1 (2023-02-09)
Bug Fixes
- app: toc visual fixes, now it is easier to visually determine the level of the element (449c0f0)
- builder: using the
browser builder, ng build completes successfully but doesn't exit (25bebac), closes #7
15.1.0 (2023-02-08)
Bug Fixes
- app: copy code button changes style based on global theme (c2e2f4e)
- core: search bar shows "Unknown" (ee53a18), closes #6
- ui-kit: the primary color is too bright for the light theme (e5e2c74)
Features
- ng-doc: add links on each page to edit guides or API documentation (9bc230a), closes #3
15.0.1 (2023-02-02)
Bug Fixes
- builder: demo viewer doesn't show source code (73ffe77)
15.0.0 (2023-02-01)
Bug Fixes
- api: ng-doc displays private-public properties that have been set by the Angular Compiler (0a82d7e)
- api: remove
override keyword from function presentation (379d65b)
- api: types in api list filter are not sorted (16d5fee)
- app: toc is not stretched to full height (1dce071)
- app: toc selection bar cut off (f582991)
- app: tooltips on API pages are not centered (2965224)
- builder: added path to API entity is not watched for changes (8723bc7)
- builder: all classes are abstract on the API page (d4f3462)
- builder: api not updating automatically when files change (1dcf640)
- builder: builder freezes if rendering fails (b8cbd72)
- builder: pages paths now uses sourceRoot folder by default (564a89e)
- builder: the dependency file was assembled incorrectly (3afda1d)
- builder: wrong links generated for duplicate class names (f8c34e2), closes #1
- demo: demo recreates component every change detection cycle (4421c7f)
- dependencies: dependency file doesn't generate assets when it was just created (e408606)
- keywords: ng-doc generates links not only for typescript code examples (8646fb8)
- ng-doc:
ng-doc doesn't forget pages that have been moved to another directory (6ba172e)
- ng-doc: add
allowSyntheticDefaultImports to ng-add (026e411)
- ng-doc: add cdk to dependencies for
@ng-doc/app (7f80a8c)
- ng-doc: add npm access for packages (0217c88)
- ng-doc: add raw-loader to the builder dependencies (a234b8e)
- ng-doc: add README.md for builder (a13325f)
- ng-doc: add schema for
ng-add command (00ed2de)
- ng-doc: angular dependencies for
ng-doc/app (fc0f36e)
- ng-doc: doesn't render all entities (99d0562)
- ng-doc: downgrade
chalk version (bc604ed)
- ng-doc: fix @ng-doc/add schematics (a705cc7)
- ng-doc: fixes for schematics (af031e3)
- ng-doc: make package public (0c4984c)
- ng-doc: move ng-add schematics to the external library (066a548)
- ng-doc: ng-add depends on nx (2515fa9)
- ng-doc: ng-add doesn't update assets (1bd745f)
- ng-doc: ng-doc doesn't update the indexes when page content has been updated (31280f8)
- ng-doc: ng-doc- destroys dependency entity after build (d62d6c5)
- ng-doc: non peer dependencies array (a3e733e)
- ng-doc: project fixes for default angular app (4361ae0)
- ng-doc: project fixes for default angular app (83c571a)
- ng-doc: release config (193dac2)
- ng-doc: release fixes (653bcb9)
- ng-doc: remove reference to builder (7e4d7bc)
- ng-doc: rename
ng-doc-add library (a91449b)
- ng-doc: search doesnt show results (af416fd)
- ng-doc: several created entities are rendered incorrectly (6761e4f)
- ng-doc: the css tab in the demo is still invisible after adding styles (ad678a7)
- ng-doc: trigger for final beta (c3e5e3b)
- ng-doc: update angular dependencies (2db13ff)
- ng-doc: update packages dependencies (3124b4e)
- page: ng-doc doesn't forget about removed demos (cc60604)
- schematics: auto import category creates incorrect import (bfc2e3e)
- schematics: category parameter raise an error if there is no category in the folder (1701fa4)
- schematics: generated dependency file has invalid import of the page (86e641b)
- tags: add color for
@Injectable decorator (03ef2bb)
Features
- api: add accessors section for classes and interfaces (b1a4610)
- api: add constructor API for classes (cf2083e)
- api: add constructor API for classes (b3f1411)
- api: add more types for classes implementing angular entities (c5101bb)
- api: add tooltips for properties badges (3812f14)
- api: constructor parameters now display overrides, inherited and implements states (f8445b4)
- api: improvements for class and interface APIs (c522ed2)
- app: add shortcut for search field (fb3fecc)
- app: add simple animation for dot in sidebar items (7c2b154)
- app: add titles for guidelines and api pages (2ed2f0d)
- app: table of contents improvements and fixes (e646dc0)
- demo: demo code will now be processed by the keyword processor (fdbb8ad)
- ng-doc:
ng-doc is out! (60af222)
- ng-doc: add
ThemeToggle component (d2ac6d3)
- project: public release (8a01852)
- tags: add
Overridden keyword for overridden methods and properties (1fff33f)
- ui-kit: add
NgDocHotkeyDirective for binding shortcuts (e931994)
- builder: improve builder performance (2543469)
BREAKING CHANGES
- ng-doc: bump major version
ng-doc