apidoc-markdown

📝 Generate a Simple and Portable Markdown documentation for your API

MIT License

Downloads
78.6K
Stars
79
Committers
9

Bot releases are visible (Hide)

apidoc-markdown - Latest Release

Published by rigwild 10 months ago

apidoc-markdown -

Published by rigwild 10 months ago

apidoc-markdown -

Published by rigwild almost 2 years ago

Full Changelog: https://github.com/rigwild/apidoc-markdown/compare/v7.2.4...v7.2.5

apidoc-markdown -

Published by rigwild almost 2 years ago

  • Fix bug with some CLI options keys not translated to apidoc CLI options #24

Full Changelog: https://github.com/rigwild/apidoc-markdown/compare/v7.2.3...v7.2.4

apidoc-markdown -

Published by rigwild almost 2 years ago

apidoc-markdown -

Published by rigwild about 2 years ago

apidoc-markdown -

Published by rigwild about 2 years ago

apidoc-markdown - v7.1.1

Published by rigwild over 2 years ago

apidoc-markdown -

Published by rigwild over 2 years ago

  • Upgrade dependencies 911699f

Update from upstream https://github.com/apidoc/apidoc/releases/tag/0.51.0:

https://github.com/rigwild/apidoc-markdown/compare/v7.0.4...v7.1.0

apidoc-markdown - v7.0.4

Published by rigwild over 2 years ago

apidoc-markdown -

Published by rigwild almost 3 years ago

  • Upgrade dependencies 1ba6b4c
  • Add apiBody and apiQuery #21 b0e25c1
  • Read configuration from apidoc.json and package.json in current working directory - fix #22 45ca9af

https://github.com/rigwild/apidoc-markdown/compare/v7.0.1...v7.0.2

apidoc-markdown -

Published by rigwild almost 3 years ago

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

https://github.com/rigwild/apidoc-markdown/compare/v6.0.1...v7.0.1

apidoc-markdown -

Published by rigwild about 3 years ago

apidoc-markdown -

Published by rigwild over 3 years ago

  • Drop node v10 support (EOL) f0af05598eb0fa09bfe50fe7e2df459b7f5e2436
apidoc-markdown -

Published by rigwild over 3 years ago

  • Closes #19 - Support header and footer options 2158914
  • Upgrade dependencies fd1ff3b

https://github.com/rigwild/apidoc-markdown/compare/v5.2.2...v5.2.3

apidoc-markdown - v5.2.2

Published by rigwild over 3 years ago

  • Upgrade dependencies
apidoc-markdown -

Published by rigwild almost 4 years ago

  • Upgrade dependencies
apidoc-markdown -

Published by rigwild almost 4 years ago

  • 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
apidoc-markdown -

Published by rigwild about 4 years ago

  • Upgrade dependencies
apidoc-markdown -

Published by rigwild about 4 years ago

  • Fix bad default template path (#17)