All Versions
Latest Version
Avg Release Cycle
138 days
Latest Release

Changelog History
Page 2

  • v0.50.0 Changes


    • --silent renamed to --quiet or -q for short
    • 🌲 --color renamed to --no-color to disable color in log output
    • πŸ“œ --parse was deleted because it is the same as --simulate
    • --simulate renamed to --dry-run / -n
    • 0️⃣ Default output is not json, use "--log-format json" to get json
    • --config / -c must be a path to a file, not a directory

    πŸ›  FIXED

    • πŸ›  Fix sampleUrl config option behavior:

      • if it is absent or false, no sample block will be generated
      • if it is true, the current page location will be used
      • if it is an url, that will be used 🚚 Note that the option useHostUrlAsSampleUrl has no longer any effect and can be safely removed. Use a value of true for sampleUrl to get the same behavior.
    • πŸ›  Fix non working sortFields function (fix #968)

    • πŸ›  Fix syntax highlighting for markdown parsed text

    • πŸ›  Fix color in logs was not showing since upgrade to winston 3

    • πŸ›  Fix newlines being removed in pre tags (fix #809 by @JayBerlin)

    • πŸ›  Fix header/footer in aloneDisplay mode (fix #905 via #1027 by @esaracco)

    • πŸ›  Fix duplicated content in aloneDisplay mode (fix #938 via #1025 by @esaracco)

    • πŸ›  Fix apiSampleRequest not working (fix #984 via #1023 by @esaracco)

    • πŸ›  Fix error with parenthesis in apiGroup (fix #994 via #1022 by @esaracco)

    • πŸ›  Fix absent diff on different api route (fix #963 via #1030 by @esaracco)

    βž• ADDED

    • βž• Add request method to compare template (#986 by @klickagent)
    • βž• Add some shorthand options, see apidoc -h
    • βž• Add --log-format option for json output (default is not json)
    • βž• Add ascii art in verbose mode
    • βž• Add --warn-error to treat warnings as error (fix #703)


    • πŸ”€ Merge apidoc-core back into the apidoc repository. The apidoc-core repository is now read-only.
    • βž• Add .eslintrc.js and enforce coding style everywhere
    • ⚑️ Update many dependencies to their latest version
    • πŸ“± Make sidenav wider and template more responsive (fix #851)
    • Big CSS code overhaul and change
    • 0️⃣ Ignore node_modules by default (fix #936)
    • βž• Add ASCII art in verbose mode
    • πŸ‘ Allow setting input and output in apidoc.json (fix #630)
    • Take standard parameters of URL query string into account (#1014 by @esaracco)
    • πŸ‘ Allow colon character in apiDefine (fix #877 via #1021 by @esaracco)
  • v0.29.0 Changes

    • πŸ›  Fix broken handlebar
    • [DEV] add a npm run serve command
    • βœ‚ Remove space that was added for optional params
    • πŸ‘‰ Make the 'optional' label unselectable (#970 by Thomas Bruun)
  • v0.28.1 Changes

    • πŸ›  Fix issue with handlebar (#967)
  • v0.28.0 Changes

    • πŸ‘‰ Use npm lockfile v2
    • ⚑️ Update handlebar to fix vulnerability (#962)
    • πŸ›  Fix runtime error in single page template (#944 via #945 by Ashlanfox)
    • πŸ“œ Implement apiBody parsing into multi page template (#953 by Seth Wheeler)
  • v0.27.0 Changes

    • Maintain comment order for @apiParam and @apiSuccess (fix #206 via #951 by Matheus Giovani)
    • βž• Add option for JavaScript output mode (#933 by refineddigital)
    • βž• Add new configuration variable useHostUrlAsSampleUrl (#930) by Shivam Kumar Jha
    • βž• Add new favicon (#926 by Francisko Arenas)
    • πŸ“œ Implement apiBody parsing into single page template (#916 by Seth Wheeler)
  • v0.26.0 Changes

    November 28, 2020


    • Clean up useless CSS rule (#923)
    • Enable GitHub actions (#918 by @tommy87)
    • πŸ“š Send sample url request to url hosting the documentation when no sampleUrl is provided in config (#915 by @thealphadollar)
  • v0.25.0 Changes

    August 14, 2020


    • βž• Add programmatic usage to README (#898 by rigwild)
    • πŸ›  Fix page refresh on non ascii characters (#896)

    Also bump the apidoc-core version.

  • v0.24.0 Changes

    July 18, 2020


  • v0.23.0 Changes

    May 30, 2020

    πŸš€ A lot of contributions in this release. A big thanks to all the contributors! :)


    • Send sample request auto json body if body/json is not used but Content-Type application/json header is set (#862)
    • πŸ›  Fix documentation not showing / Show version when withCompare is set to false (#880) Fix #879
    • βž• Add support for javascript config files (#872)
    • βž• Add support for different config files (#874)
    • πŸ›  Fix tests for Windows (#873)
    • πŸ›  Fix pre borders overflowing on print view (#887)
  • v0.22.1 Changes

    May 01, 2020