Docgeni Versions Save

📖 A modern, powerful and out of the box documentation generator for Angular components lib and markdown docs.(现代化的、强大的、开箱即用的 Angular 组件文档生成工具)

v2.2.2

5 months ago

v2.2.1

6 months ago

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 (https://github.com/docgeni/docgeni/issues/509) (9d196a1) Features core: return headings when build component #INFR-9194 (4dce242), closes #INFR-9194 ngdoc: use @public mark methods of component as public https://github.com/docgeni/docgeni/issues/504 (8000f12)

v2.2.0

11 months ago

Features

  • support Angular v16 version

Bug Fixes

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

v2.1.0

1 year ago

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)

v2.0.1

1 year ago

v2.0.0

1 year ago

https://zhuanlan.zhihu.com/p/583359359

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)

v1.1.0

2 years ago

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)