@docgeni/core

Core of Docgeni

Usage

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

const docgeni = new Docgeni(options);
docgeni.run(config);

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-next.6 (2024-09-29)

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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/core

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

Note: Version bump only for package @docgeni/core

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)

Note: Version bump only for package @docgeni/core

2.3.2-next.1 (2024-04-23)

Note: Version bump only for package @docgeni/core

2.3.2-next.0 (2024-04-23)

Bug Fixes

• 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

2.3.1 (2024-04-12)

Note: Version bump only for package @docgeni/core

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: support pipe api doc (#515) (c60e648)

2.2.2 (2023-11-21)

Note: Version bump only for package @docgeni/core

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)

Features

• core: return headings when build component #INFR-9194 (4dce242), closes #INFR-9194

2.2.0 (2023-05-23)

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)

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/core

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)

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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

Bug Fixes

• core: update .ts to **/.ts for ngDocParser component (5b702f8)

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)

Features

• core: update site-template to ng 15 (2aac8ff)

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

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)

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

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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)

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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)

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)

Note: Version bump only for package @docgeni/core

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)

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/core

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

Note: Version bump only for package @docgeni/core

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

Features

• 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

• 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)

Features

• core: example support background, compact and className #OSP-66 (#386) (0050190), closes #OSP-66

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

Features

• template: remove cdk deps (6d51ad0)

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

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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

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

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

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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

Features

• core: add debug logs for LibraryBuilder #OSP-249 (#338) (212cb5f), 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

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

Bug Fixes

• core: remove extractCss from angular.json (#337) (94773ff)

Features

• core: support sourceMap Support emitDecoratorMetadata (#304) (674281c)
• core: update to es2020 (9b795c5)

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

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)

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/core

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

Note: Version bump only for package @docgeni/core

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

Bug Fixes

• 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

• core: use define name in lib example component to generate entry file #OSP-167 (#288) (61de9b8), closes #OSP-167
• add serve/build config configuration (#283) (80b210e)
• core: generate sitemap by config #OSP-192 (#263) (9ec9300), closes #OSP-192 #OSP-192
• core: support config favicon.ico (#282) (72c9b11)
• ngdoc: add @docgeni/ngdoc and init structure #OSP-226 (#284) (0fbc3c5), closes #OSP-226
• 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

• 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

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

• 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)

Bug Fixes

• core: add ng command args prod and port (#252) (840bffc)

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)

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: 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)

Features

• core: add tty progress and compilation feature #OSP-163 (#232) (f635042), closes #OSP-163

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

Features

• core: add tty progress and compilation feature #OSP-163 (#232) (f635042), closes #OSP-163

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)

Note: Version bump only for package @docgeni/core

1.0.7 (2021-07-02)

Bug Fixes

• core: remove default description, default is empty #OSP-154 (d00bdc8), closes #OSP-154

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)

Features

• core: add clear method to DocSourceFile and refactor it use DocgeniHost #177 (#193) (4271f4c)
• bundle scss and css(#188) (cd3206c)

1.0.4 (2021-06-25)

Note: Version bump only for package @docgeni/core

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)

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)

1.0.0 (2021-05-20)

Note: Version bump only for package @docgeni/core

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

Bug Fixes

• 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

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

Note: Version bump only for package @docgeni/core

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)

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: should get corrent content when there are two same paths in different channels #OSP-99 (#144) (597d060), closes #OSP-99

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

Note: Version bump only for package @docgeni/core

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

Features

• core: auto add tsconfig paths for create site (#119) (532d1d8)

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

Bug Fixes

• core: should build success when public assets dir is not exist and delete site (#116) (1fea06a)
• 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)

Features

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

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

Note: Version bump only for package @docgeni/core

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

Features

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

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

Note: Version bump only for package @docgeni/core

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)

Features

• api: ApiDeclaration support interface & class (cb7ec62)
• core: support config siteDir (3f0ea8f)
• core: update site angular.json output & root (044ef16)

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

• 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

• core: should not throw error when exclude is undefined (0a8999e)

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

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/core

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)

Features

• template: beautify style for navbar and api table (a5b1a2c)

0.5.6 (2020-08-28)

Note: Version bump only for package @docgeni/core

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)

Note: Version bump only for package @docgeni/core

0.5.3 (2020-07-11)

Note: Version bump only for package @docgeni/core

0.5.2 (2020-07-11)

Bug Fixes

• core: exclude index.md source file for example dir (dc64b53)

0.5.1 (2020-07-11)

Note: Version bump only for package @docgeni/core

0.5.0 (2020-06-26)

Note: Version bump only for package @docgeni/core

0.4.0 (2020-06-25)

Bug Fixes

• core: category support front-matter path (bebf0cc)

0.3.0 (2020-06-24)

Note: Version bump only for package @docgeni/core

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)

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

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)

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: 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)

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)

Note: Version bump only for package @docgeni/core

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

Note: Version bump only for package @docgeni/core

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.0 (2020-05-26)

Features

• code: can't compile docs when docsPath is null 0r 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: 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