@docgeni/toolkit

Toolkit for Docgeni or cli tools

Usage

const { toolkit } = require('@docgeni/toolkit');

toolkit.initialize({ baseDir: __dirname});
toolkit.print.info(`Hey, I'm Docgeni!`);
toolkit.print.success(`success`);

Here's what's available inside the toolkit object you see all over Docgeni.

Accessing Toolkit Directly

You can access almost all of Docgeni 's toolkit tools without toolkit.

const { Print, fs, strings } = require('@docgeni/toolkit');
// or
const { Print } = require('@docgeni/toolkit/print');
const * as fs = require('@docgeni/toolkit/filesystem');
const * as strings = require('@docgeni/toolkit/strings');

const print = new Print();
print.info(`Hey, I'm Docgeni!`);
fs.dir('/tmp/peter');
print.error('error);

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.5.0-next.0 (2024-12-10)

Features

• upgrade ng to 19 and set default standalone to true (#572) (7858059)

2.4.0 (2024-10-23)

Bug Fixes

• get signal input aliasName from argumentInfo (#566) (5bd80af)

Features

• support signals contains input, output and model (#556) (81128f4)
• banner support dark theme #TINFR-585 (#561) (ccf0bed), closes #TINFR-585
• support config and switch light,dark,system themes #TINFR-412 (#559) (6c57638), closes #TINFR-412
• update angular.json use default application builder (a936b05)
• upgrade ng to 18 (#554) (279aed0)

2.4.0-next.6 (2024-09-29)

Bug Fixes

• get signal input aliasName from argumentInfo (#566) (5bd80af)

2.4.0-next.5 (2024-09-27)

Features

• support signals contains input, output and model (#556) (81128f4)

2.4.0-next.4 (2024-09-19)

Features

• banner support dark theme #TINFR-585 (#561) (ccf0bed), closes #TINFR-585

2.4.0-next.3 (2024-09-03)

Features

• support config and switch light,dark,system themes #TINFR-412 (#559) (6c57638), closes #TINFR-412

2.4.0-next.2 (2024-08-19)

Note: Version bump only for package docgeni

2.4.0-next.1 (2024-08-18)

Note: Version bump only for package docgeni

2.4.0-next.0 (2024-08-18)

Features

• update angular.json use default application builder (a936b05)
• upgrade ng to 18 (#554) (279aed0)

2.3.2 (2024-04-23)

Bug Fixes

• cli: should not show help for default command (d83a95c)
• core: trigger recompile when latest compilation is finished (fa37adb)
• ngdoc: cache latest file content, only trigger watcher func when file content changed #OSP-625 (#542) (4f5ee09), closes #OSP-625

Features

• add create-docgeni (4b6f24d)

2.3.1 (2024-04-12)

Features

• ngdoc: support parse alias in input params #INFR-12159 (0cc36cf), closes #INFR-12159
• upgrade ng to 17 (#530) (4e9b483)

2.3.0 (2023-12-27)

Bug Fixes

• core: add custom path for component (87954ae)

2.3.0-next.0 (2023-12-05)

Features

• core: export standalone components from examples module for stack-blitz #INFR-10671 (#518) (abbeffd), closes #INFR-10671
• ngdoc: pipe api doc default public (8e83c1b)
• ngdoc: support pipe api doc (#515) (c60e648)

2.2.2 (2023-11-21)

Bug Fixes

• toolkit: add ora to dependencies of toolkit (51229a3)

Features

• toolkit: copy support exclude (9f56049)

2.2.1 (2023-10-25)

Bug Fixes

• core: set default sort of category to 0 (c251e82)
• core: should sort navs of component lib without category (0f21bb5)
• template: show next and pre in root dir (#509) (9d196a1)

Features

• core: return headings when build component #INFR-9194 (4dce242), closes #INFR-9194
• ngdoc: use @public mark methods of component as public #504 (8000f12)

2.2.0 (2023-05-23)

Features

• support Angular v16 version

  Bug Fixes

• remove entryComponents (4818fe3)

• core: remove defaultProject and update root to src for site angular.json (33a4e70)

2.1.1 (2023-04-24)

Bug Fixes

• should load root components when include is undefined or empty (8169bbc)
• core: remove defaultProject and update root to src for site angular.json

2.1.0 (2023-04-21)

Bug Fixes

• cli: ng-add remove --prod flag (964b12a)
• core: exclude examples and spec files when parse api docs (bbd009b)
• ngdoc: replace logic of custom parse tags by signature with ts tag infos array #469 (#471) (518cfc7)
• template: update word-break to break-all of api table td (6b86d17)
• template: update sub selectors of dg-doc-content to avoid cover elements styles of example viewer #432 (3b7d623)
• core: update .ts to **/.ts for ngDocParser component (5b702f8)
• ngdoc: methods duplicate removal for overload (#465) (d31178a)
• ngdoc: use getTypeAtLocation by identifier for get heritage declarations in other module (d2ffeec)
• core: mark enableIvy as override for LibExampleLoader #458 (#461) (f42f2ad)
• core: update default value to property.default when it is not undefined or null #424 (#463) (83bd8cb)
• ngdoc: should parse correct tags when has multi-language (#459) (ab8ab53)
• template: update homeMeta to nullable for home template (e563102)
• update tag h1 to span for dg-doc-header avoid conflict (3a12593)

Features

• core: remove default logic that parse components for lib root path, only according to include, and root dir exclude include in config (76d1e78)
• cli: set apiMode to automatic when ng add @docgeni/cli (2288c3e)
• core: update site-template to ng 15 (2aac8ff)
• ngdoc: parse heritage declarations for directives, services and class-likes #INFR-6929 (edf7a6d), closes #INFR-6929
• core: custom components support standalone #INFR-6938 (#455) (721b17c), closes #INFR-6938
• core: example support standalone component #INFR-6744 (#450) (08d517c), closes #INFR-6744
• ngdoc: support interface and class api doc when mark public or publicApi (#452) (81dcaca)
• template: exports "./styles/index.css" in @docgeni/template (83b3f99)
• template: exports "./styles/index.css" in @docgeni/template (83b3f99)
• template: add exports of scss in package.json (c10a8a0)

2.1.0-next.11 (2023-04-21)

Bug Fixes

• cli: ng-add remove --prod flag (964b12a)

Features

• core: remove default logic that parse components for lib root path, only according to include, and root dir exclude include in config (76d1e78)

2.1.0-next.10 (2023-04-19)

Note: Version bump only for package docgeni

2.1.0-next.9 (2023-04-14)

Bug Fixes

• core: exclude examples and spec files when parse api docs (bbd009b)

2.1.0-next.8 (2023-04-13)

Bug Fixes

• ngdoc: replace logic of custom parse tags by signature with ts tag infos array #469 (#471) (518cfc7)
• template: update word-break to break-all of api table td (6b86d17)

2.1.0-next.7 (2023-04-12)

Bug Fixes

• template: update sub selectors of dg-doc-content to avoid cover elements styles of example viewer #432 (3b7d623)

2.1.0-next.6 (2023-04-04)

Bug Fixes

• core: update .ts to **/.ts for ngDocParser component (5b702f8)
• ngdoc: methods duplicate removal for overload (#465) (d31178a)
• ngdoc: use getTypeAtLocation by identifier for get heritage declarations in other module (d2ffeec)

2.1.0-next.5 (2023-03-28)

Bug Fixes

• core: mark enableIvy as override for LibExampleLoader #458 (#461) (f42f2ad)
• core: update default value to property.default when it is not undefined or null #424 (#463) (83bd8cb)
• ngdoc: should parse correct tags when has multi-language (#459) (ab8ab53)
• template: update homeMeta to nullable for home template (e563102)

Features

• cli: set apiMode to automatic when ng add @docgeni/cli (2288c3e)
• core: update site-template to ng 15 (2aac8ff)
• ngdoc: parse heritage declarations for directives, services and class-likes #INFR-6929 (edf7a6d), closes #INFR-6929

2.1.0-next.4 (2023-03-17)

Bug Fixes

• update tag h1 to span for dg-doc-header avoid conflict (3a12593)

Features

• core: custom components support standalone #INFR-6938 (#455) (721b17c), closes #INFR-6938
• core: example support standalone component #INFR-6744 (#450) (08d517c), closes #INFR-6744
• ngdoc: support interface and class api doc when mark public or publicApi (#452) (81dcaca)
• template: exports "./styles/index.css" in @docgeni/template (83b3f99)

2.1.0-next.3 (2023-03-10)

Features

• template: exports "./styles/index.css" in @docgeni/template (83b3f99)

2.1.0-next.2 (2023-03-09)

Note: Version bump only for package docgeni

2.1.0-next.1 (2023-03-09)

Features

• template: add exports of scss in package.json (c10a8a0)

2.1.0-next.0 (2023-03-09)

Note: Version bump only for package docgeni

2.0.1 (2022-11-17)

Bug Fixes

• core: validate tsconfig.lib.json exists for compatible and automatic apiMode (7651886)
• ngdoc: should convert tsConfigPath and rootDir to ts supported path for windows (#416) (f1889cf)

2.0.0 (2022-11-14)

Performance Improvements

• remove warning messages (661f45f)

Features

• core: generate example module support vars define providers, declarations and imports, and remove default export from module (#400) (55f2371)
• core: support define module.ts in .docgeni/app folder (#401) (03e8c52)
• core: throw error when child_process is error exit (87b4a82)
• ngdoc: ignore site typescript error (5ee49ad)
• ngdoc: support set @sort tag for directives and services (#395) (900f04e)
• template: add parentheses () wrapper for name when kind is Output (d91143d)
• core: support render all examples for overview (#389) (d61f728)
• ngdoc: add @type custom type (b1ba6fd)
• template: display aliasName first and add "#" before name for ContentChild and ContentChildren kinds (#388) (5a671b5)
• core: example support background, compact and className #OSP-66 (#386) (0050190), closes #OSP-66
• ngdoc: hide component and property when add private or internal and rewrite directive name for name tag (41a15a1)
• template: remove cdk deps (6d51ad0)
• ngdoc: update getCurrentDirectory use ts.sys.getCurrentDirectory and add debug logs (99cbd66)
• core: add debug logs for LibraryBuilder #OSP-249 (#338) (212cb5f), closes #OSP-249
• ngdoc: add debug logs for ng-parser #OSP-249 (#339) (9f96b9e), closes #OSP-249
• core: add debug logs for LibraryBuilder #OSP-249 (#338) (212cb5f), closes #OSP-249
• ngdoc: add debug logs for ng-parser #OSP-249 (#339) (9f96b9e), closes #OSP-249
• core: update to es2020 (9b795c5)
• template: add toc to api #OSP-41 (#300) (e5c1c2a), closes #OSP-41
• support service api (#303) (37b8ef0)
• core: support sourceMap Support emitDecoratorMetadata (#304) (674281c)
• core: auto generate and update examples module source #OSP-218 (#291) (5e88168), closes #OSP-218
• core: supoort default locale in docs or docs/locale (#289) (3c8fd72)
• core: support automatic generate api docs #OSP-230 (#294) (5b428a0), closes #OSP-230
• core: support custom imports and providers for custom built-in component (#293) (6aa9612)

Bug Fixes

• template: add text-decoration for title of navbar-brand (d5d23e1)
• core: combine metadata bootstrap as long as one has a value (1234de7)
• template: update justify-content: end; to flex-end (7d0cee7)
• template: switch locale use Location service for scene with base-href (#398) (6fe13b5)
• core: should prevent the next build while building (365f323)
• cli: remove id from schema.json support ng 13 cli (28a5554)
• core: should encode headingId to fix heading contains a link #362 (eebcd4d)
• core: should use getSystemPath to convert path for compatible with windows system #376 (#383) (e2b8b25)
• ngdoc: should ignore watch json files #364 (3bd92ab)
• cli: add $id for schema of schematic (efb40eb)
• ngdoc: only watch resolved modules in rootDir and exclude others such as node_modules #359 (#360) (8669684)
• core: remove progress from serve options (a31ef90)
• core: add BrowserAnimationsModule to AppModule (5356a60)
• core: remove progress args from serve (#355) (a2d3509)
• core: should ignore without exported components when generating entry module (190a288)
• core: getExpectExportedComponent without example name (c3171cc)
• core: update index.ts after change custom built-in components #OSP-242 (a2954e7), closes #OSP-242
• template: get corrected doc item when component is same in multiple libraries #347 (3c9ea1a)
• template: import docsearch.css instead of docsearch.min.css (bf3ec3d)
• template: set text-decoration as none for link in nav (cb005b6)
• template: update outline button styles for launch action (eb0b593)
• template: use navigateByUrl when click search result item path is inernal route #OSP-253 #350 (152e6f7), closes #OSP-253
• core: should not build example when entry component file is not exists #OSP-251 (0e3cb83), closes #OSP-251
• template: update word-break to break-all for toc link and table label #OSP-252 (8ed816c), closes #OSP-252
• ngdoc: use useCaseSensitiveFileNames to normalize filePath (c0ea534)
• core: remove extractCss from angular.json (#337) (94773ff)
• core: should get correct source file for node_modules types #OSP-244 (1f84bcc), closes #OSP-244
• template: set search container width and font-size (a8364c9)
• core: should generate correct output path for docs #295 (#298) (5e18a3a)
• core: should transform to real abs path for cosmiconfig search #OSP-239 (#299) (fea46c8), closes #OSP-239
• template: remove space from name of content-renderer (abd804d)
• core: fix error when has't modult.ts (cbbddf6)
• core: should generate stackblize bundle.json for examples when custom site project (#290) (bcf79b8)
• template: improve api display for empty properties and spacing (801a0db)
• horizontal line top of footer do not overlap when doc meta is empty (6d75e03)
• alib: rename a-lib to @docgeni/alib and publish to npm (317211c)
• core: regenerate examples source bundle file when emit and refactor somethings #OSP-223 (5d0e2bc), closes #OSP-223
• core: should generate navs success when there are no locale docs folder that configured in locales #OSP-211 (#268) (697a366), closes #OSP-211
• template: add @angular/cdk to dependencies of template and move @angular-devkit/schematics to cli (#267) (c136a0f)
• template: fix import docsearch error (#274) (9492006)

2.0.0-next.0 (2022-11-14)

Bug Fixes

• template: add text-decoration for title of navbar-brand (d5d23e1)

1.2.0-next.27 (2022-11-02)

Bug Fixes

• core: combine metadata bootstrap as long as one has a value (1234de7)

Performance Improvements

• remove warning messages (661f45f)

1.2.0-next.26 (2022-11-02)

Bug Fixes

• template: update justify-content: end; to flex-end (7d0cee7)

Features

• core: generate example module support vars define providers, declarations and imports, and remove default export from module (#400) (55f2371)
• core: support define module.ts in .docgeni/app folder (#401) (03e8c52)

1.2.0-next.25 (2022-09-22)

Bug Fixes

• template: switch locale use Location service for scene with base-href (#398) (6fe13b5)

1.2.0-next.24 (2022-09-05)

Bug Fixes

• core: should prevent the next build while building (365f323)

Features

• core: throw error when child_process is error exit (87b4a82)
• ngdoc: ignore site typescript error (5ee49ad)
• ngdoc: support set @sort tag for directives and services (#395) (900f04e)
• template: add parentheses () wrapper for name when kind is Output (d91143d)

1.2.0-next.23 (2022-08-17)

Features

• core: support render all examples for overview (#389) (d61f728)

1.2.0-next.22 (2022-08-10)

Note: Version bump only for package docgeni

1.2.0-next.21 (2022-08-09)

Note: Version bump only for package docgeni

1.2.0-next.20 (2022-08-05)

Features

• ngdoc: add @type custom type (b1ba6fd)
• template: display aliasName first and add "#" before name for ContentChild and ContentChildren kinds (#388) (5a671b5)

1.2.0-next.19 (2022-08-01)

Bug Fixes

• cli: remove id from schema.json support ng 13 cli (28a5554)
• core: should encode headingId to fix heading contains a link #362 (eebcd4d)
• core: should use getSystemPath to convert path for compatible with windows system #376 (#383) (e2b8b25)
• ngdoc: should ignore watch json files #364 (3bd92ab)

Features

• core: example support background, compact and className #OSP-66 (#386) (0050190), closes #OSP-66
• ngdoc: hide component and property when add private or internal and rewrite directive name for name tag (41a15a1)

1.2.0-next.18 (2022-07-28)

Features

• template: remove cdk deps (6d51ad0)

1.2.0-next.17 (2022-07-27)

Bug Fixes

• cli: add $id for schema of schematic (efb40eb)

1.2.0-next.15 (2022-07-27)

Note: Version bump only for package docgeni

1.2.0-next.14 (2022-05-05)

Bug Fixes

• ngdoc: only watch resolved modules in rootDir and exclude others such as node_modules #359 (#360) (8669684)

1.2.0-next.13 (2022-04-25)

Bug Fixes

• core: remove progress from serve options (a31ef90)

1.2.0-next.12 (2022-04-25)

Bug Fixes

• core: add BrowserAnimationsModule to AppModule (5356a60)
• core: remove progress args from serve (#355) (a2d3509)
• core: should ignore without exported components when generating entry module (190a288)

1.2.0-next.11 (2022-04-24)

Bug Fixes

• core: getExpectExportedComponent without example name (c3171cc)
• core: update index.ts after change custom built-in components #OSP-242 (a2954e7), closes #OSP-242
• template: get corrected doc item when component is same in multiple libraries #347 (3c9ea1a)
• template: import docsearch.css instead of docsearch.min.css (bf3ec3d)
• template: set text-decoration as none for link in nav (cb005b6)
• template: update outline button styles for launch action (eb0b593)
• template: use navigateByUrl when click search result item path is inernal route #OSP-253 #350 (152e6f7), closes #OSP-253

1.2.0-next.10 (2022-03-10)

Bug Fixes

• core: should not build example when entry component file is not exists #OSP-251 (0e3cb83), closes #OSP-251
• template: update word-break to break-all for toc link and table label #OSP-252 (8ed816c), closes #OSP-252

1.2.0-next.9 (2022-03-08)

Bug Fixes

• ngdoc: use useCaseSensitiveFileNames to normalize filePath (c0ea534)

1.2.0-next.8 (2022-03-08)

Features

• ngdoc: update getCurrentDirectory use ts.sys.getCurrentDirectory and add debug logs (99cbd66)

1.2.0-next.7 (2022-03-08)

Features

• core: add debug logs for LibraryBuilder #OSP-249 (#338) (212cb5f), closes #OSP-249
• ngdoc: add debug logs for ng-parser #OSP-249 (#339) (9f96b9e), closes #OSP-249

1.2.0-next.6 (2022-03-08)

Features

• core: add debug logs for LibraryBuilder #OSP-249 (#338) (212cb5f), closes #OSP-249
• ngdoc: add debug logs for ng-parser #OSP-249 (#339) (9f96b9e), closes #OSP-249

1.2.0-next.5 (2022-03-08)

Bug Fixes

• core: remove extractCss from angular.json (#337) (94773ff)
• core: should get correct source file for node_modules types #OSP-244 (1f84bcc), closes #OSP-244
• template: set search container width and font-size (a8364c9)

Features

• core: update to es2020 (9b795c5)
• template: add toc to api #OSP-41 (#300) (e5c1c2a), closes #OSP-41
• support service api (#303) (37b8ef0)
• core: support sourceMap Support emitDecoratorMetadata (#304) (674281c)

1.2.0-next.4 (2021-12-20)

Bug Fixes

• core: should generate correct output path for docs #295 (#298) (5e18a3a)
• core: should transform to real abs path for cosmiconfig search #OSP-239 (#299) (fea46c8), closes #OSP-239
• template: remove space from name of content-renderer (abd804d)

1.2.0-next.3 (2021-12-17)

Bug Fixes

• core: fix error when has't modult.ts (cbbddf6)
• core: should generate stackblize bundle.json for examples when custom site project (#290) (bcf79b8)
• template: improve api display for empty properties and spacing (801a0db)

Features

• core: auto generate and update examples module source #OSP-218 (#291) (5e88168), closes #OSP-218
• core: supoort default locale in docs or docs/locale (#289) (3c8fd72)
• core: support automatic generate api docs #OSP-230 (#294) (5b428a0), closes #OSP-230
• core: support custom imports and providers for custom built-in component (#293) (6aa9612)

1.2.0-next.2 (2021-11-17)

Note: Version bump only for package docgeni

1.2.0-next.1 (2021-11-16)

Note: Version bump only for package docgeni

1.2.0-next.0 (2021-11-16)

Bug Fixes

• horizontal line top of footer do not overlap when doc meta is empty (6d75e03)
• alib: rename a-lib to @docgeni/alib and publish to npm (317211c)
• core: regenerate examples source bundle file when emit and refactor somethings #OSP-223 (5d0e2bc), closes #OSP-223
• core: should generate navs success when there are no locale docs folder that configured in locales #OSP-211 (#268) (697a366), closes #OSP-211
• template: add @angular/cdk to dependencies of template and move @angular-devkit/schematics to cli (#267) (c136a0f)
• template: fix import docsearch error (#274) (9492006)

Features

• cli: ng-add schematics add @docgei/angular dependency (eca5b5b)
• core: generate sitemap by config #OSP-192 (#263) (9ec9300), closes #OSP-192 #OSP-192
• core: support config favicon.ico (#282) (72c9b11)
• core: use define name in lib example component to generate entry file #OSP-167 (#288) (61de9b8), closes #OSP-167
• ngdoc: add @docgeni/ngdoc and init structure #OSP-226 (#284) (0fbc3c5), closes #OSP-226
• ngdoc: add getExportsComponents for NgDocParser and refactor ngdoc #OSP-231 (1af561b), closes #OSP-231
• add serve/build config configuration (#283) (80b210e)
• example support stackblitz (#276) (9fe6a9c)
• template: add builtins search #OSP-202 (#271) (caf7724), closes #OSP-202 #OSP-202

1.1.4 (2021-10-18)

Bug Fixes

• cli: add "@schematics/angular" to dependencies (2574537)
• core: remove default value / for base-href #OSP-210 (142c349), closes #OSP-210

1.1.3 (2021-10-18)

Bug Fixes

• core: add ansi-colors to dependencies of core #OSP-209 (9cd9e72), closes #OSP-209
• init command generate gitignore (2251649)
• template: add docsearch.js dependent to @docgeni/template #OSP-205 (c2bfc66), closes #OSP-205

1.1.2 (2021-10-15)

Features

• cli: remove angular dependencies from cli #OSP-203 (9144978), closes #OSP-203

1.1.1 (2021-10-14)

Bug Fixes

• doc-meta not change (cad3946)
• should display home meta when content is empty (#255) (ce92350)
• template: move load built-in components to module constructor and invoke cdr.markForCheck #OSP-200 (92380fb), closes #OSP-200

Features

• template: search docs support algolia #OSP-5 (#239) (79a2912), closes #OSP-5 #OSP-5 #OSP-5

1.1.0 (2021-09-30)

Features

• template: sidebar category support expand and collapse(#244) (3538670)
• core: embed support line select (#238) (fdfc34f)
• template: add switch locale by url as /zh-cn/xxx #OSP-86 (#245) (2a0e80c), closes #OSP-86
• template: support content, menu and hidden toc config for doc (#240) (61442ad)
• core: add tty progress and compilation feature #OSP-163 (#232) (f635042), closes #OSP-163
• template: add page links for pre and next page (f06a04c)
• template: doc-meta contributor add title (8dcb876)
• core: add tty progress and compilation feature #OSP-163 (#232) (f635042), closes #OSP-163
• template: add page links for pre and next page (f06a04c)
• template: doc-meta contributor add title (8dcb876)
• core: add tty progress and compilation feature #OSP-163 (#232) (f635042), closes #OSP-163
• template: add page links for pre and next page (f06a04c)
• template: doc-meta contributor add title (8dcb876)
• core: add doc-contribution (#212) (7f53eb5)
• template: add source-code , copy components and refactor example-viewer use source-code and copy #OSP-181 (#220) (9b5ded4), closes #OSP-181
• template: footer support custom (#222) (652a8b1)
• template: support open isolated example #OSP-162 (a700170), closes #OSP-162
• template: update dg-copy default color to $dg-gray-500, hover change to primary (f33117d)
• template: add built-in component embed (517206)
• template: add built-in alert (5454d4c)
• core: add custom components feature (77c827e)
• template: feat(template): add built-in component infrastructure and render them by content-viewer (3e874e9)
• core: add label for component (1ecfbae)
• template: support home page (e2051f6)

Bug Fixes

• core: add ng command args prod and port (#252) (840bffc)
• template: add originPath for component doc and display doc-meta only for available doc (3ee26e2)
• template: find link use id for scrollToAnchor and init scroll container before set links #OSP-197 (96fef31), closes #OSP-197
• template: sidebar arrow status (#248) (f31e719)
• core: should generate emitted path use custom name via component doc frontmatter #OSP-193 (#247) (96c123e), closes #OSP-193
• core: remove deleted docs from compile parms when delete doc file #OSP-191 (84cb57e), closes #OSP-191
• template: refresh page with fragment auto scrollToAnchor #OSP-190 (#243) (6ebd0e5), closes #OSP-190
• core: fix empty path error when exec ng command for custom site and remove redundant name for lib example path (90d7776)
• template: update get doc item by path for lite mode (#229) (b2925e0)
• toolkit: git log names with spaces error (#226) (056a43c)
• template: update get doc item by path for lite mode (#229) (b2925e0)
• toolkit: git log names with spaces error (#226) (056a43c)

1.1.0-next.9 (2021-09-29)

Bug Fixes

• template: add originPath for component doc and display doc-meta only for available doc (3ee26e2)
• template: find link use id for scrollToAnchor and init scroll container before set links #OSP-197 (96fef31), closes #OSP-197
• template: sidebar arrow status (#248) (f31e719)

Features

• template: sidebar category support expand and collapse(#244) (3538670)

1.1.0-next.8 (2021-09-26)

Bug Fixes

• core: should generate emitted path use custom name via component doc frontmatter #OSP-193 (#247) (96c123e), closes #OSP-193

1.1.0-next.7 (2021-09-24)

Bug Fixes

• core: remove deleted docs from compile parms when delete doc file #OSP-191 (84cb57e), closes #OSP-191
• template: refresh page with fragment auto scrollToAnchor #OSP-190 (#243) (6ebd0e5), closes #OSP-190

Features

• core: embed support line select (#238) (fdfc34f)
• template: add switch locale by url as /zh-cn/xxx #OSP-86 (#245) (2a0e80c), closes #OSP-86
• template: support content, menu and hidden toc config for doc (#240) (61442ad)

1.1.0-next.6 (2021-09-18)

Bug Fixes

• core: fix empty path error when exec ng command for custom site and remove redundant name for lib example path (90d7776)
• template: update get doc item by path for lite mode (#229) (b2925e0)
• toolkit: git log names with spaces error (#226) (056a43c)

Features

• core: add tty progress and compilation feature #OSP-163 (#232) (f635042), closes #OSP-163
• template: add page links for pre and next page (f06a04c)
• template: doc-meta contributor add title (8dcb876)

1.1.0-next.5 (2021-09-18)

Bug Fixes

• template: update get doc item by path for lite mode (#229) (b2925e0)
• toolkit: git log names with spaces error (#226) (056a43c)

Features

• core: add tty progress and compilation feature #OSP-163 (#232) (f635042), closes #OSP-163
• template: add page links for pre and next page (f06a04c)
• template: doc-meta contributor add title (8dcb876)

1.1.0-next.4 (2021-09-10)

Features

• core: add doc-contribution (#212) (7f53eb5)
• template: add source-code , copy components and refactor example-viewer use source-code and copy #OSP-181 (#220) (9b5ded4), closes #OSP-181
• template: footer support custom (#222) (652a8b1)
• template: support open isolated example #OSP-162 (a700170), closes #OSP-162
• template: update dg-copy default color to $dg-gray-500, hover change to primary (f33117d)

Note: Version bump only for package docgeni

1.0.7 (2021-07-02)

Bug Fixes

• core: remove default description, default is empty #OSP-154 (d00bdc8), closes #OSP-154
• template: set text-decoration: none to dg-tab-link hover fix confict (04d0a5f)

Features

• template: support en-us and zh-cn lang for overview and example #OSP-118 (#198) (c69a71a), closes #OSP-118

1.0.6 (2021-07-02)

Bug Fixes

• use index.scss for site-template (6b1c45b)

1.0.5 (2021-07-02)

Bug Fixes

• template: remove $yiq warning use math.div (7c68eb3)
• template: remove max-height: 100vh for dg-doc-viewer (97e4944)
• template: replace 1000 to 100 for fix $yiq style (4ef2a5b)

Features

• core: add clear method to DocSourceFile and refactor it use DocgeniHost #177 (#193) (4271f4c)
• template: auto switch to browser lang when it supported (#191) (5c72764)
• bundle scss and css(#188) (cd3206c)

Reverts

• revert $yiq use slash from @use "sass:math"; (33d0265)

1.0.4 (2021-06-25)

Bug Fixes

• toolkit: incorrect succuss to success (eeaeb7a)

1.0.3 (2021-06-17)

Bug Fixes

• template: set position sticky to dg-toc and add dg-scroll-container (434b244)

Features

• template: add language switch in lite mode (#182) (5e80d2c)

1.0.2 (2021-06-07)

Bug Fixes

• core: remove include dirs from exclude for scanning lib components #179 (fa02c1e)
• update angular cli analytics default value to false #175 (a5e9a5a)

Features

• template: update open mode to over from push for sidebar (#173) (8996ace)

1.0.1 (2021-05-31)

Bug Fixes

• core: fix path in windows (69d8a25)
• core: fix run in windows env (b9e760f)
• core: fix test expect (ba1e5e5)
• core: log full path when docs dir is not exists (76ae3fc)
• core: should use abs docs path to validate exists (b509149)
• core: use getSystemPath translate path for copy (d558083)
• template: fix dg-doc-content and dg-examples styles (4f502be)

1.0.0 (2021-05-20)

Bug Fixes

• template: temp hide external icon for example viewer (7dcfa11)

1.0.0-beta.7 (2021-05-19)

Bug Fixes

• cli: remove <12 in peerDependencies for support ng 12 (4e75e52)
• core: should not throw error when include dir is not exists #OSP-123 (35d9e39), closes #OSP-123

1.0.0-beta.6 (2021-05-19)

Bug Fixes

• core: always build site , don't check src dir #OSP-113 (c097cf0), closes #OSP-113
• template: fit responsive for nav and sidebar (#158) (ff4956f)

1.0.0-beta.5 (2021-05-19)

Note: Version bump only for package docgeni

1.0.0-beta.4 (2021-05-18)

Bug Fixes

• core: generate tsconfig paths exception throw if no package.json found (8812e7d)
• core: markdown highlight for bash ng and others (#147) (f75a1b4)
• template: shoule find component doc by path and importSpecifier (1efe281)

Features

• core: normalize and verify lib config, and add test #OSP-95 (3759aa2), closes #OSP-95
• core: normalize config for navs, locales and verify configs #OSP-95 (b46fabd), closes #OSP-95
• core: watch public files (#141) (c7c7c31)

1.0.0-beta.3 (2021-05-15)

Bug Fixes

• core: should export configurable properties for lib (b504b1d)
• template: remove footer (b52a4c1)
• template: should get corrent content when there are two same paths in different channels #OSP-99 (#144) (597d060), closes #OSP-99

Features

• cli: json-schema (#138) (dce686a)

1.0.0-beta.2 (2021-05-12)

Bug Fixes

• template: fix toc href when has baseHref (0121ae9)
• template: set data-level according to highestLevel (ecc5583)

Features

• cli: docgeni serve/build support ng serve/build command args (#131) (0fcfb48)

1.0.0-beta.1 (2021-04-01)

Bug Fixes

• template: add timestamp for request navigations json to avoid browser cache old data (7cf6123)
• template: should redirect fisrt component when click component channel (#120) (abe9736)
• template: should use default language when cache locale is not supported (b16a188)

Features

• cli: ng add action (6af32fd)
• core: auto add tsconfig paths for create site (#119) (532d1d8)

1.0.0-beta.0 (2021-03-30)

Bug Fixes

• cli: update getting-started template content (056b2f9)
• core: should build success when public assets dir is not exist and delete site (#116) (1fea06a)
• template: remove home route only when there is route path is empty for lite mode (2e525bb)
• template: should redirect to first doc when click channel and current route is under the channel (#115) (6bdf157)

Features

• core: update output to outputDir and refactor docs (8423abb)

0.6.0-next.18 (2021-03-25)

Bug Fixes

• core: update docgeni default siteDir to .docgeni/site (#110) (66352f5)
• template: should redirect first doc when there are no docs in subfolder's parent folder (bd708b4)

Features

• core: support publicDir contains assets,.browserslistrc, index.html,tsconfig.json and styles.scss (#111) (ac43a96)

0.6.0-next.17 (2021-03-24)

Bug Fixes

• template: update peerDependencies as * (c1e8c4a)

0.6.0-next.16 (2021-03-24)

Bug Fixes

• template: support 9.0.0 (9fec5a0)
• template: update peerDependencies support angular 11 (4615c9c)

Features

• cli: add @type support for js config (a19542e)

0.6.0-next.15 (2021-03-18)

Bug Fixes

• template: add flex auto for dg-doc-viewer--single (addc61f)
• template: should display page without channel (39b6b7c)

0.6.0-next.14 (2021-03-18)

Features

• core: should display index.md as page when mode is lite (bb3b604)
• core: update docsPath to docsDir and refactor component docs (f289f8f)

0.6.0-next.13 (2021-03-18)

Bug Fixes

• template: should hide x scroll for lite mode (bc50415)

Features

• api: ApiDeclaration support interface & class (cb7ec62)
• cli: add docgeni init command (#94) (c3e126b)
• core: support config siteDir (3f0ea8f)
• core: update site angular.json output & root (044ef16)
• template: show level in table of content (#91) (74baf15), closes #OSP-12
• toc: stick toc in top (4fb5d06)

0.6.0-next.12 (2021-03-11)

Bug Fixes

• fix test error in circleci (ff5137f)

Features

• cli: @docgeni/cli add schematics (#88) (3f992d3)

0.6.0-next.11 (2021-02-25)

Bug Fixes

• should be used as a third-party library when NODE_ENV is not prod and src is not exist (fe18a2e)

0.6.0-next.10 (2021-02-24)

Bug Fixes

• change toolkit and core types to lib.index.d.ts (d8b7278)

0.6.0-next.9 (2021-02-22)

Bug Fixes

• core: update outputPath to root dist dir (60cbb0e)

Features

• core: add hidden support hide some doc nav #INFR-670 (3e04101), closes #INFR-670

0.6.0-next.8 (2021-02-20)

Features

• cli: add partial schematics to cli #INFR-1648 (88abf5a), closes #INFR-1648

0.6.0-next.7 (2021-02-20)

Bug Fixes

• core: generate example module keys exclude components with out examples #INFR-1644 (8acbbb8), closes #INFR-1644

0.6.0-next.6 (2021-02-20)

Bug Fixes

• cli: update cli rxjs tslib and zone.js versions (0862480)
• core: fix windows err about spawn and cross-env #INFR-1574 (3750db8), closes #INFR-1574
• core: should remove example highlighted content from EXAMPLE_COMPONENTS #INFR-1644 (9bd7077), closes #INFR-1644

0.6.0-next.5 (2021-01-18)

Bug Fixes

• cli: update angular dependencies version (ab749bb)
• core: should not throw error when exclude is undefined (0a8999e)

0.6.0-next.4 (2021-01-18)

Bug Fixes

• cli: update cli dependencies @docgeni/template (2ccebaa)

Features

• cli: add angular build & serve command options contains port,deployUrl,baseHref support (66dced5)

0.6.0-next.3 (2021-01-07)

Bug Fixes

• core: ignore non md file when build doc navs and don't throw error when entryFile is null (73be38b)
• template: export IsModeFullPipe and IsModeLitePipe and simply AppModule (30c7491)

Features

• cli: add @angular dependencies to @docgeni/cli (e408745)

0.6.0-next.2 (2021-01-04)

Bug Fixes

• core: fix build error remove unused code (3e470a7)
• core: should reread doc content when watch changes (2c8f4bf)

Features

• core: generate content index.ts for AppModule (1041345)
• core: support project without angular siteProject (29bb54d)

0.6.0-next.1 (2021-01-03)

Note: Version bump only for package docgeni

0.6.0-next.0 (2021-01-02)

Features

• support lite mode and refactor lib and doc builder (6e72eba)

0.5.8 (2020-12-29)

Features

• template: upgrade ng to 10.0.0 (63af2be)

0.5.7 (2020-12-05)

Bug Fixes

• template: img max width 100% (5ce156c)
• template: remove min-height for example-viewer-sources-content (1353e2b)

Features

• template: beautify style for navbar and api table (a5b1a2c)
• template: increase HTML display priority (e3503b7)

0.5.6 (2020-08-28)

Bug Fixes

• template: fix navbar responsive for theme (abfe573)
• template: update background rgba from 12% to 0.12 (088ea49)

0.5.5 (2020-08-28)

Features

• template: change api doc style and generate json files (b6404d4)
• template: support default and angular theme #INFR-606 (#59) (b64a246), closes #INFR-606

0.5.4 (2020-07-14)

Bug Fixes

• template: fix error about BrowserModule has already been loaded (48cb303)
• template: remove BrowserModule from shared module (eb4f041)

0.5.3 (2020-07-11)

Bug Fixes

• export all public-api remove barrel index (c47db82)

0.5.2 (2020-07-11)

Bug Fixes

• core: exclude index.md source file for example dir (dc64b53)
• template: load assets path change to relative (b79881c)

0.5.1 (2020-07-11)

Bug Fixes

• template: fix navigations json assets path (9dcb715)
• template: heading font-size change (098036a)
• template: replace url when navigate to channel page from home (e902f74)
• template: toc active scroll to anchor (774004e)

0.5.0 (2020-06-26)

Features

• template: mobile responsive for nav and sidebar (54de98e)

0.4.0 (2020-06-25)

Bug Fixes

• core: category support front-matter path (bebf0cc)
• template: table width 100% (f555c62)

0.3.0 (2020-06-24)

Bug Fixes

• redirect to empty when component has not doc, api and examples (1ba8f6f)

0.2.1 (2020-06-24)

Bug Fixes

• core: don't show properties table when properties is empty (79a9890)

Features

• template: add unformed toc for doc and component overview #INFR-377 (8019c48), closes #INFR-377

0.2.0 (2020-06-20)

Features

• core: add api feature for component #INFR-481 (6ee18e2), closes #INFR-481

0.1.0 (2020-06-16)

Features

• core: component support name front-matter and support lib docDir and examplesDir config #INFR-685 (14026f6), closes #INFR-685

0.1.0-alpha.13 (2020-06-13)

Bug Fixes

• add @docgeni/template to core 's peerDependencies (68832b4)
• core: fix import sub dir component examples module error (0cd9a55)

0.1.0-alpha.12 (2020-06-13)

Bug Fixes

• template: set line-height as 1.5715 (cc15b95)
• ui: layout style error (9d943ed)

Features

• core: add include for lib support subdir components #INFR-662 (ee3a255), closes #INFR-662
• core: sort lib components by order, and support example front-matter #INFR-643 (3df0d03), closes #INFR-643
• template: add table style for doc content (19457aa)

0.1.0-alpha.11 (2020-06-12)

Bug Fixes

• cli: serve command and rename cmdOptions to cmdArgs (0332e25)
• template: hide locale select when only has one locale (8363dec)

Features

• template: support subtitle display (02e4136)

0.1.0-alpha.10 (2020-06-11)

Features

• core: add cutome logoUrl config, default show docgeni logo #INFR-604 (4d00039), closes #INFR-604
• core: integrate angular cli serve and build command (9e89803)
• template: add PageTitleService and set title in doc detail page #INFR-611 (ba6b776), closes #INFR-611
• template: example load support ViewEngine, only dynamic load in Ivy #INFR-613 (557480d), closes #INFR-613

0.1.0-alpha.9 (2020-06-06)

Bug Fixes

• remove nav item when there is no doc or examples (3903799)

Features

• template: change doc content styles (b4952ce)

0.1.0-alpha.8 (2020-06-03)

Features

• core: lib support exclude and doc or examples can be empty #INFR-564 (c6fae1f), closes #INFR-564

0.1.0-alpha.7 (2020-05-27)

Bug Fixes

• template: remove bootstrap, add dg-main dg-footer class (3144ace)

0.1.0-alpha.6 (2020-05-27)

Note: Version bump only for package docgeni

0.1.0-alpha.5 (2020-05-27)

Bug Fixes

• core: ensure assets content dir exists (5dcb7ce)

0.1.0-alpha.4 (2020-05-27)

Features

• template: redirect first channel page when home meta is null #INFR-512 (f1ba43a), closes #INFR-512

0.1.0-alpha.3 (2020-05-27)

Bug Fixes

• don't throw error when libs is null or empty (4783960)

0.1.0-alpha.2 (2020-05-27)

Bug Fixes

• add docgen to package.json 's bin (5a1a7c2)

0.1.0-alpha.1 (2020-05-27)

Bug Fixes

• build cli package lib exclude src (e18048d)

0.1.0-alpha.0 (2020-05-26)

Bug Fixes

• add example(alib-foo-basic-example) for getting started (a9e20df)

Features

• core: can't compile docs when docsPath is null or empty (bcc3239)
• core: add generate navigations for locales #INFR-424 (#19) (1ca9f06), closes #INFR-424 #INFR-424 #INFR-424
• core: dynamic generate examples and load in component detail page runtime (d8023c0)
• core: generate component examples and example loaders #INFR-324 (66999eb), closes #INFR-324
• core: generate highlighted examples and show it #INFR-479 (0709518), closes #INFR-479
• core: generate navs and docs content html files by docs folder #INFR-331 (7192d77), closes #INFR-331
• core: inline example support #INFR-478 (34f7173), closes #INFR-478
• core: lib support categories config and refactor interfaces #INFR-330 (bdc71a4), closes #INFR-330
• core: recompile watch docs and lib change first version #INFR-480 (7b2eb5d), closes #INFR-480
• core: support markdown doc highlight #INFR-470 (e63826a), closes #INFR-470
• core: use index.md‘s front matter represent category #INFR-488 (a1a9a55), closes #INFR-488
• template: add component viewer and doc viewer show diff docs #INFR-158 (d6a1ddb), closes #INFR-158
• template: add content-view component #INFR-374 (668adf4), closes #INFR-374
• template: add copier service and use it in example viewer, change doc content styles #INFR-375 (f7cf619), closes #INFR-375
• template: add icon component, replace navbar icon and example viewer #INFR-372 (9441fac), closes #INFR-372
• template: component viewer style change, add nav scss, and refactor all template scss #INFR-320 (35db888), closes #INFR-320
• template: show live example use markdown stynx #INFR-321 (f420511), closes #INFR-321
• template: sidebar styles improve #INFR-319 (af9c84d), closes #INFR-319
• template: switch example source tabs #INFR-323 (cc9e8da), closes #INFR-323