Skip to content

Releases: rigwild/apidoc-markdown

v7.0.2

22 Dec 23:19
Compare
Choose a tag to compare
  • Upgrade dependencies 1ba6b4c
  • Add apiBody and apiQuery #21 b0e25c1
  • Read configuration from apidoc.json and package.json in current working directory - fix #22 45ca9af

v7.0.1...v7.0.2

v7.0.1

30 Oct 16:37
Compare
Choose a tag to compare
  • Upgrade dependencies
  • Use pnpm
  • Use apidoc-light instead of normal apidoc
  • Integrate apidoc parsing

Breaking changes

  • Node.js v14+ required
  • apidoc-markdown no longer uses output files from apiDoc, it does the generation directly by importing it
  • -p option removed

How to upgrade

Remove apiDoc as it is now directly imported by apidoc-markdown

pnpm remove apidoc

Change your generation command. Use option --input instead (just as you would do with apiDoc directly)

src is where are stored your code/source files containing some apiDoc annotations

apidoc-markdown -i src -o DOCUMENTATION.md

Should be good to go ☺

v6.0.1...v7.0.1

v6.0.1

15 Sep 17:30
Compare
Choose a tag to compare

v6.0.0...v6.0.1

v6.0.0

04 Jul 20:04
Compare
Choose a tag to compare
  • Drop node v10 support (EOL) f0af055

v5.2.3

18 Apr 21:00
Compare
Choose a tag to compare
  • Closes #19 - Support header and footer options 2158914
  • Upgrade dependencies fd1ff3b

v5.2.2...v5.2.3

v5.2.2

22 Mar 21:11
Compare
Choose a tag to compare
  • Upgrade dependencies

v5.2.1

21 Dec 13:18
Compare
Choose a tag to compare
  • Upgrade dependencies

v5.2.0

21 Nov 16:37
Compare
Choose a tag to compare
  • Upgrade dependencies
  • Select a template by its name (default, bitbucket)
  • Pass a raw plain text EJS template directly on the command line (the parser will understand your --template argument is a plain template if it contains an EJS open tag <%)
  • Added a bitbucket-compatible template (#18)
  • Fix --createPath which could fail when using --multi and passing a file instead of a directory
  • Use EJS async template compiler
  • Added lots of tests

v5.1.8

21 Sep 13:41
Compare
Choose a tag to compare
  • Upgrade dependencies

v5.1.7

19 Sep 19:49
Compare
Choose a tag to compare
  • Fix bad default template path (#17)