jsonschema2md

Convert Complex JSON Schemas into Markdown Documentation

APACHE-2.0 License

Downloads
31.8K
Stars
581
Committers
50
jsonschema2md - v4.0.12

Published by trieloff over 4 years ago

4.0.12 (2020-01-30)

Bug Fixes

  • dont use backslash for URLs on windows (5149522), closes #211
jsonschema2md - v4.0.11

Published by trieloff over 4 years ago

4.0.11 (2020-01-26)

Bug Fixes

  • package: fix & clean up dependencies (890e86d), closes #210
jsonschema2md - v4.0.10

Published by trieloff almost 5 years ago

4.0.10 (2020-01-21)

Bug Fixes

  • deps: pin es2015-i18n-tag version (c531b50), closes #207
jsonschema2md - v4.0.9

Published by trieloff almost 5 years ago

4.0.9 (2020-01-20)

Bug Fixes

  • markdown: prevent unescaped objects in markdown AST (87d709a), closes #201
jsonschema2md - v4.0.8

Published by trieloff almost 5 years ago

4.0.8 (2020-01-15)

Bug Fixes

  • index.js: -x flag is not working properly for the suppression case (d929d9b)
jsonschema2md - v4.0.7

Published by trieloff almost 5 years ago

4.0.7 (2020-01-14)

Bug Fixes

  • markdown: increase robustness when using format as a property name (cda0bec), closes #198
jsonschema2md - v4.0.6

Published by trieloff almost 5 years ago

4.0.6 (2020-01-14)

Bug Fixes

  • markdown: catch error when using title as a property name (b4b8855)
jsonschema2md - v4.0.5

Published by trieloff almost 5 years ago

4.0.5 (2020-01-14)

Bug Fixes

  • slugger: fix slugger crash due to title property (4f0ab31), closes #196
jsonschema2md - v4.0.4

Published by trieloff almost 5 years ago

4.0.4 (2020-01-14)

Bug Fixes

  • cli: do not exit after creating readme.md (cb7d012)
  • cli: make the -n or --no-readme option work again (3c63c03)
  • loader: guard against endless wrapping (dd1f7f6), closes #194
jsonschema2md - v4.0.3

Published by trieloff almost 5 years ago

4.0.3 (2020-01-09)

Bug Fixes

  • schema: do not recurse endlessly when writing cyclic schemas (297f0d5), closes #185
jsonschema2md - v4.0.2

Published by trieloff almost 5 years ago

4.0.2 (2019-12-20)

Bug Fixes

  • cli: fix traverse function when called from CLI (f211375)
jsonschema2md - v4.0.1

Published by trieloff almost 5 years ago

4.0.1 (2019-12-20)

Bug Fixes

  • titles: more robust handling of title generation for untitled schemas (c546a28), closes #185
  • traversal: fix endless loop in schema traversal (af85c59), closes #185
jsonschema2md - v4.0.0

Published by trieloff almost 5 years ago

4.0.0 (2019-12-16)

Bug Fixes

  • i18n: use correct file name format (43a74f4)
  • markdown: constraint values can be zero now (2e057fd)
  • markdown: handle null as a constant value (e652e11)
  • proxy: remove logging statements (616a1d9)
  • schemas: remove references going nowhere (2186142)

Build System

  • dependencies: remove unused dependencies (dbc9192)

Code Refactoring

  • cli: remove bluebird, lodash, simplify arg parsing (b6b1822)

Continuous Integration

Documentation

Features

  • cli: generate JSON schema output (dd18f3b), closes #176
  • formats: add support for formats: json-pointer, relative-json-pointer, regex, and uri-template (689c158)
  • i18n: new internationalization system (1a664de)
  • i18n: provide complete en_US translation (5eb0c89)
  • markdown: add header surpression (6225b9f)
  • markdown: add support for default keyword (72a0fde)
  • markdown: add support for comments (07bb52f)
  • markdown: add YAML frontmatter support (4df92e6)
  • markdown: create and write markdown (e521541)
  • markdown: generate additional detail (cc07df2)
  • markdown: generate header again (011427c)
  • markdown: generate some property details (fa34cf1)
  • markdown: generate type details (c9f19e1)
  • markdown: highlight keyword usage for documentation (d35e4ed), closes #100
  • markdown: list nested schemas in README (608674b)
  • markdown: list nested schemas in README (87e8489)
  • markdown: show examples (c8e8dfa)
  • markdown: show extensibility and abstraction in header (90a9a8e)
  • markdown: show id and status in header (08e1923)
  • markdown: show id and status in header (b6fcf53)
  • markdown: show join types (12af018)
  • markdown: show some info about properties, switch i18n library (f8a32df)
  • markdown: show type, link, additional and custom properties in header (eff129a)
  • markdown: show value constraints (515969c)
  • markdown: support item arrays and additionalItems (c9fbcdf), closes #31
  • markdown: support patternProperties and additionalProperties (1386ee3), closes #95 #180
  • proxy: generate meta information (ac65ac6)
  • proxy: generate slugs (eacbf38)
  • proxy: resolve references (4cea068)
  • readme: generate readme again (d6b9e5e)
  • readme: mention the most common schema version (fc583d7)
  • schema: add full support for "A Vocabulary for the Contents of String-Encoded Data" (96ca3a6)
  • schema: add support for keyword $defs (70b63c8)
  • schema: add support for keyword deprecated (934b856)
  • schema: add support for readOnly and writeOnly schemas and properties (7452882)

BREAKING CHANGES

  • changelog:
  • i18n: The file format for the i18n files has changed

You can now specify the language to use using -l and jsonschema2md will pick up the correct language configuration.

  • test: Node 8 is no longer supported
  • dependencies: Removes the JSON schema validation feature entirely
  • cli: Repaces lodash with ferrum, removed bluebird, changes the meaning of --schema-out or -x to be no longer relative to output dir

The --schema-out or -x command line option is no longer relative to the output path (specified with -o or --out)

jsonschema2md - v3.3.1

Published by trieloff about 5 years ago

3.3.1 (2019-09-18)

Bug Fixes

  • package: update @adobe/helix-log to version 2.0.0 (33792f6)
jsonschema2md - v3.3.0

Published by trieloff about 5 years ago

3.3.0 (2019-08-26)

Features

  • allow display of custom attributes in the property description (0634309), closes #151
jsonschema2md - v3.2.0

Published by trieloff about 5 years ago

3.2.0 (2019-08-20)

Features

jsonschema2md - v3.1.2

Published by trieloff about 5 years ago

3.1.2 (2019-08-07)

Bug Fixes

  • always output POSIX paths (3c1c42c)
  • fix error logging from submodules (dc634b2)
jsonschema2md - v3.1.1

Published by trieloff about 5 years ago

3.1.1 (2019-07-31)

Bug Fixes

  • i18n init: moved the i18n init part to the cli.js (5e37d2d), closes #157
  • markdownwriter.js: use path function to resolve the path (5fe7db2), closes #157
jsonschema2md - v3.1.0

Published by trieloff about 5 years ago

3.1.0 (2019-07-30)

Features

  • i18n: enable localization of all strings, provide en as default language (daa58a2), closes #143
jsonschema2md - v3.0.1

Published by trieloff about 5 years ago

3.0.1 (2019-07-29)

Bug Fixes

  • schema.js: fix $ref not being resolved when nested deeper than once within an object (6eb73c3), closes #155
Package Rankings
Top 1.68% on Npmjs.org
Top 8.17% on Proxy.golang.org
Badges
Extracted from project README
GitHub Actions