jsonschema2md

Convert Complex JSON Schemas into Markdown Documentation

APACHE-2.0 License

Downloads
31.8K
Stars
581
Committers
50
jsonschema2md - v6.0.0

Published by trieloff over 3 years ago

6.0.0 (2021-04-04)

Bug Fixes

  • lib/traverseschema.js: filter out skippable keywords based on parent's type (0f75837), closes #282

BREAKING CHANGES

  • lib/traverseschema.js: If schema contained 'properties', 'required' or 'examples' as a part of JSON schema
    (i.e. it was described as 'properties' within an object of 'object' type), these will be included
    into output.
jsonschema2md - v5.0.7

Published by trieloff over 3 years ago

5.0.7 (2021-04-02)

Bug Fixes

  • deps: update dependency @adobe/helix-log to v5.0.2 (040a495)
jsonschema2md - v5.0.6

Published by trieloff over 3 years ago

5.0.6 (2021-04-02)

Bug Fixes

  • deps: update dependency @adobe/helix-log to v5.0.1 (0017876)
jsonschema2md - v5.0.5

Published by trieloff over 3 years ago

5.0.5 (2021-03-20)

Bug Fixes

  • deps: update dependency readdirp to v3.6.0 (47a37dc)
jsonschema2md - v5.0.4

Published by trieloff over 3 years ago

5.0.4 (2021-03-06)

Bug Fixes

  • deps: update external fixes (d409140)
jsonschema2md - v5.0.3

Published by trieloff over 3 years ago

5.0.3 (2021-02-25)

Bug Fixes

  • deps: update dependency @adobe/helix-log to v5 (#285) (ca21fe4)
jsonschema2md - v5.0.2

Published by trieloff over 3 years ago

5.0.2 (2021-01-30)

Bug Fixes

  • lib/markdownBuilder.js: use simpletitle for makeproperties (d2100c6)
jsonschema2md - v5.0.1

Published by trieloff almost 4 years ago

5.0.1 (2021-01-25)

Bug Fixes

  • deps: update external fixes (48ed197)
jsonschema2md - v5.0.0

Published by trieloff almost 4 years ago

5.0.0 (2021-01-21)

Bug Fixes

  • deps: bump semantic-release versions (44cc702)
  • deps: npm audit fix (24a577e)
  • deps: update dependency @adobe/helix-log to v4.5.3 (19f7ab4)
  • deps: update dependency js-yaml to v4 (2dbca6f)
  • schemaproxy.js: fix resolving $refs that are file references (c6adf01), closes #92
  • traverseschema.js: skip generating files for certain keywords in the schema (fc50969)

BREAKING CHANGES

  • traverseschema.js: The extranious files, if they have some other value, will not be generated and
    there is no mechanism to continue to g
jsonschema2md - v4.2.2

Published by trieloff almost 4 years ago

4.2.2 (2020-12-14)

Bug Fixes

  • schemaproxy.js: fix resolving $refs that are file references (c6adf01), closes #92
jsonschema2md - v4.2.1

Published by trieloff about 4 years ago

4.2.1 (2020-10-21)

Bug Fixes

  • lib/markdownbuilder.js: propTable property anchor link generated with github-slugger (9883b8f)
jsonschema2md - v4.2.0

Published by trieloff about 4 years ago

4.2.0 (2020-09-01)

Features

  • markdownbuilder: create an option to skip any property in markdown #243 (56b7a2f)
jsonschema2md - v4.1.6

Published by trieloff about 4 years ago

4.1.6 (2020-07-31)

Bug Fixes

  • markdown: correcly show type of nullable types in header (53c1a0b), closes #237
jsonschema2md - v4.1.5

Published by trieloff over 4 years ago

4.1.5 (2020-06-22)

Bug Fixes

  • deps: npm audit fix (2be8a58)
  • markdown: avoid ambiguities around property names (a4543c4), closes #232
jsonschema2md - v4.1.4

Published by trieloff over 4 years ago

4.1.4 (2020-06-22)

Bug Fixes

  • definition object defintions based on proplist structure (2fb9fc5), closes #228
jsonschema2md - v4.1.3

Published by trieloff over 4 years ago

4.1.3 (2020-06-04)

Bug Fixes

  • moved definitions to bottom of output file (1b27fff), closes #226
jsonschema2md - v4.1.2

Published by trieloff over 4 years ago

4.1.2 (2020-04-23)

Bug Fixes

  • lib/index.js: made -h/--header a boolean arg (5ba2719), closes #209
jsonschema2md - v4.1.1

Published by trieloff over 4 years ago

4.1.1 (2020-04-14)

Bug Fixes

  • deps: npm audit fix (b13ab35)
  • enum: fix doc generation for enums that contain arrays (667a106), closes #219
jsonschema2md - v4.1.0

Published by trieloff over 4 years ago

4.1.0 (2020-03-05)

Features

  • examples: enable examples to be formatted in YAML using command line option -f yaml (01119ba)
jsonschema2md - v4.0.13

Published by trieloff over 4 years ago

4.0.13 (2020-01-31)

Bug Fixes

  • i18n: update German translations (8cf38e4)
Package Rankings
Top 1.68% on Npmjs.org
Top 8.17% on Proxy.golang.org
Badges
Extracted from project README
GitHub Actions