Skip to content

Latest commit

 

History

History
191 lines (106 loc) · 11 KB

CHANGELOG.md

File metadata and controls

191 lines (106 loc) · 11 KB
Raw

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.6.0 (2022-10-27)

Features

  • Add table of contents to the HTML theme (0b96e9c)
  • Improve the HTML theme's scanability by adding (...) to function declaration headlines (f4d677c)

0.5.1 (2021-06-28)

Bug Fixes

  • Fix the problem caused by flexsearch quoting cdn without specifying the version. Currently, it is modified to 0.6.32 to ensure that there will be no errors due to the upgrade to 0.7 (40b6c34)

0.5.0 (2021-05-05)

⚠ BREAKING CHANGES

  • To keep other dependencies up to date, fliegdoc no longer supports node v10 (as v10 has also reached EOL of being maintained). You now require node v12 or higher to use fliegdoc

Features

Bug Fixes

  • Fix compatibility issues for ts-morph v10 (0d87d87)

0.4.7 (2021-02-06)

Bug Fixes

  • html-theme: Add support for UTF-8 characters (for non-English documentation) (#47) (d3159f6)

0.4.6 (2021-02-05)

Bug Fixes

  • html-theme: Fix constructor function name undefined (db6d4ce), closes #37

0.4.5 (2021-01-24)

Bug Fixes

  • Upgrade search-popup to v2 and remove scroll-behavior: smooth due to incompatibility (f6a481e), closes #26

0.4.4 (2021-01-21)

Bug Fixes

  • html-theme: Fix extends declaration implementation for classes (2c2e159)

0.4.3 (2021-01-19)

Features

  • Replace string.replaceAll call with string.replace (e970fb1), closes #20
  • Support NodeJS 10+ (#28) (622d6ca), closes #20

Bug Fixes

  • html-theme: Fix broken links in search index introduced in be6baffca4bf663c9f6664397f319c659e162059 (4041fc0)

0.4.2 (2021-01-11)

Features

0.4.1 (2021-01-08)

Features

  • Add fliegdoc [i|init] to generate a fliegdoc.config.js (044319e)

0.4.0 (2021-01-08)

⚠ BREAKING CHANGES

  • serveDynamic no longer renders the templates "on request", but instead once when called
  • Private class members are now hidden by default. To re-enable them, you must set hidePrivateMembers: false in your config
  • Instead of passing the configuration overrides as parameters to the individual functions, you now have to call require('fliegdoc').setConfig(config, configBasePath) to set a configuration

Features

  • theme: Add local image handling for README.md in HTML Theme (ecff4fd)
  • Add option to hide private class members (0dffeb8), closes #6
  • Export HTMLTheme in index.ts (b6eb166)
  • Extract theme into an object passable to the config as theme (dc21697), closes #7
  • Improve class documentation template (f4600d9)
  • Improve function documentation template (b506770)
  • Move default-html to html (be4423c)
  • Rename DefaultHTMLTheme to HTMLTheme (ec30134)
  • Revamp API configuration system (c69493e), closes #5

Bug Fixes

  • Fix creating directories in buildStatic (9d66ebd)
  • Remove console.log statement in serveDynamic (c87a4a1)

0.3.2 (2021-01-07)

Bug Fixes

  • Also apply custom TSDoc parser in interfaces and classes (4fe187a)

0.3.1 (2021-01-07)

Bug Fixes

  • Remove external links from DEFAULT_CONFIG (8cc925b)

0.3.0 (2021-01-07)

⚠ BREAKING CHANGES

  • Tags in TSDoc comments (@example, @returns, etc.) have to be the first element in the line, now. The only exeception to this is {@link ABC}, which works inline.

Features

0.2.0 (2021-01-07)

⚠ BREAKING CHANGES

  • dependencies: Views now have to be written using eta

Features

  • Add externalLinks config parameter to add external links to the page (1d7a8ef)
  • Add title config parameter to adjust the doc page title (32d876b)
  • dependencies: Replaced chalk with more lightweight colorette (ec219b2)
  • dependencies: replaced ejs with more light-weight and faster eta (cbd5ea1)
  • dependencies: replaced markdown-it with more light-weight and faster remarkable (fc858a4)

Bug Fixes

0.1.8 (2021-01-07)

Bug Fixes

  • Include Typescript Definitions in package (ba75936)

0.1.7 (2021-01-07)

Bug Fixes

  • View folder location for serveDynamic() (8c0cdde)

0.1.6 (2021-01-07)

Features

  • Type optimizations, ESLint (aa60111)

0.1.5 (2021-01-07)

0.1.4 (2021-01-07)

0.1.3 (2021-01-07)

0.1.2 (2021-01-07)

0.1.1 (2021-01-07)

0.1.0 (2021-01-07)

Features

  • Add baseUrl config option (65e923b)
  • cli: Add option to serve the build output statically after the build (2933bc2)
  • cli: Add port option to build and serve (cc3782d)
  • cli: Progress feedback and zsh completion script (4ce2ee5)
  • Added CLI functionality and documentation using the tool itself :P (c01bc7a)
  • Initial commit (de67ad1)

Bug Fixes

  • theme: Removed old "default" headline in header (c9caefd)
  • theme: Removed old "default" headline in header (d62a41b)
  • Move @ts-ignore comment back into correct line (411e509)