apidoc-markdown

📝 Generate a Simple and Portable Markdown documentation for your API

MIT License

Downloads
78.6K
Stars
79
Committers
9

Bot releases are hidden (Show)

apidoc-markdown -

Published by rigwild about 4 years ago

  • Upgrade dependencies
apidoc-markdown -

Published by rigwild over 4 years ago

  • Upgrade dependencies
apidoc-markdown -

Published by rigwild over 4 years ago

  • Fix #16 - prepend FS not loading file (was inserting the file name in the document)
apidoc-markdown -

Published by rigwild over 4 years ago

  • Order groups and titles by name ascending (#15)
apidoc-markdown -

Published by rigwild over 4 years ago

  • Add engines field to package.json, Node v10+ required (fs.promises API) (fix #14)
  • Upgrade dependencies
apidoc-markdown -

Published by rigwild over 4 years ago

  • Use code splitting for semver lib
  • Edit default template to include newline before tables (fixes #13 )
apidoc-markdown -

Published by rigwild over 4 years ago

Commits:

  • Upgrade dependencies bbb8821
  • Update default template (fixes #12 b6f0987, 981ee58):
    • Add missing types in code blocks
    • Support data groups
apidoc-markdown -

Published by rigwild over 4 years ago

apidoc-markdown -

Published by rigwild over 4 years ago

  • Upgrade dependencies
  • Update README
  • Fix multi generation mode having an any type
apidoc-markdown -

Published by rigwild over 4 years ago

Got the original npm package name! The new package name is apidoc-markdown.

The old package @rigwild/apidoc-markdown is now fully deprecated.

If you are upgrading from @rigwild/apidoc-markdown to apidoc-markdown, you must uninstall @rigwild/apidoc-markdown first (see How to uninstall).

apidoc-markdown -

Published by rigwild over 4 years ago

  • Distribute TypeScript sources with npm packages (sources map)
  • Use fs.promises.readFile in utf-8 mode instead of using .toString()
apidoc-markdown -

Published by rigwild over 4 years ago

Major release.

Introducing a real programmatic usage. The old system was just a CLI wrapper where you passed paths on from files on your file system. The project has been reworked to directly accept apiDoc data objects and prepend/template as strings.

See Programmatic usage API.

Check the README.md for new features.

  • Full refactor. Added real programmatic usage
  • Update README
  • Update examples with apidoc-example
  • Update tests
  • Fix #8
  • Cleaned template random spacings
  • Fix order setting sometimes crashes
apidoc-markdown -

Published by rigwild over 4 years ago

Upgraded dependencies

apidoc-markdown -

Published by rigwild almost 5 years ago

  • Added support for legacy apidoc.json file
  • Updated apiDoc example data
  • Examples TypeScript rewrite
  • Tests update
apidoc-markdown -

Published by rigwild almost 5 years ago

  • Fixed @apiError not showing - See #6
  • Added more details to success and error responses
  • Removed dist from repository in favor of .npmignore file - See #7
  • Removed Todo section from README.md
  • Updated dependencies
apidoc-markdown -

Published by rigwild almost 5 years ago

  • Update License + author email
  • Update dependencies
  • Fix package.json format error
apidoc-markdown -

Published by rigwild about 5 years ago

  • Full project refactor
  • TypeScript rewrite
  • Better tests
  • Better programmatic usage
apidoc-markdown - Release 2.1.0

Published by rigwild over 5 years ago