UNPKG

@adobe/jsonschema2md/CHANGELOG.md

Version:
27.6 kBMarkdownView Raw
1## [6.0.1](https://github.com/adobe/jsonschema2md/compare/v6.0.0...v6.0.1) (2021-04-12)
2
3
4### Bug Fixes
5
6* **deps:** update dependency @adobe/helix-log to v5.0.3 ([#299](https://github.com/adobe/jsonschema2md/issues/299)) ([b3bc372](https://github.com/adobe/jsonschema2md/commit/b3bc372f6a4d7e1a8266e3409124194724fc5b78))
7
8# [6.0.0](https://github.com/adobe/jsonschema2md/compare/v5.0.7...v6.0.0) (2021-04-04)
9
10
11### Bug Fixes
12
13* **lib/traverseschema.js:** filter out skippable keywords based on parent's type ([0f75837](https://github.com/adobe/jsonschema2md/commit/0f7583706f61faf4e933359d73664890779fcd80)), closes [#282](https://github.com/adobe/jsonschema2md/issues/282)
14
15
16### BREAKING CHANGES
17
18* **lib/traverseschema.js:** If schema contained 'properties', 'required' or 'examples' as a part of JSON schema
19(i.e. it was described as 'properties' within an object of 'object' type), these will be included
20into output.
21
22## [5.0.7](https://github.com/adobe/jsonschema2md/compare/v5.0.6...v5.0.7) (2021-04-02)
23
24
25### Bug Fixes
26
27* **deps:** update dependency @adobe/helix-log to v5.0.2 ([040a495](https://github.com/adobe/jsonschema2md/commit/040a495ed085f8150682b8129d71a3dacbe3f31a))
28
29## [5.0.6](https://github.com/adobe/jsonschema2md/compare/v5.0.5...v5.0.6) (2021-04-02)
30
31
32### Bug Fixes
33
34* **deps:** update dependency @adobe/helix-log to v5.0.1 ([0017876](https://github.com/adobe/jsonschema2md/commit/0017876e77a6dedfb226ef01bbf03fd3d043c72a))
35
36## [5.0.5](https://github.com/adobe/jsonschema2md/compare/v5.0.4...v5.0.5) (2021-03-20)
37
38
39### Bug Fixes
40
41* **deps:** update dependency readdirp to v3.6.0 ([47a37dc](https://github.com/adobe/jsonschema2md/commit/47a37dc96c93517262cb4e518bdfc87ce585edd6))
42
43## [5.0.4](https://github.com/adobe/jsonschema2md/compare/v5.0.3...v5.0.4) (2021-03-06)
44
45
46### Bug Fixes
47
48* **deps:** update external fixes ([d409140](https://github.com/adobe/jsonschema2md/commit/d4091408c019f40c5f40e2d46dd85aba7b6fc112))
49
50## [5.0.3](https://github.com/adobe/jsonschema2md/compare/v5.0.2...v5.0.3) (2021-02-25)
51
52
53### Bug Fixes
54
55* **deps:** update dependency @adobe/helix-log to v5 ([#285](https://github.com/adobe/jsonschema2md/issues/285)) ([ca21fe4](https://github.com/adobe/jsonschema2md/commit/ca21fe4d77665231aa493ab4f924e8c802e9efcf))
56
57## [5.0.2](https://github.com/adobe/jsonschema2md/compare/v5.0.1...v5.0.2) (2021-01-30)
58
59
60### Bug Fixes
61
62* **lib/markdownBuilder.js:** use simpletitle for makeproperties ([d2100c6](https://github.com/adobe/jsonschema2md/commit/d2100c61ccc76307f839179a11931ca99d2e79bd))
63
64## [5.0.1](https://github.com/adobe/jsonschema2md/compare/v5.0.0...v5.0.1) (2021-01-25)
65
66
67### Bug Fixes
68
69* **deps:** update external fixes ([48ed197](https://github.com/adobe/jsonschema2md/commit/48ed1979814b78d0a0e9c8e888e7ca7df711079f))
70
71# [5.0.0](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v5.0.0) (2021-01-21)
72
73
74### Bug Fixes
75
76* **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c))
77* **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3))
78* **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092))
79* **deps:** update dependency js-yaml to v4 ([2dbca6f](https://github.com/adobe/jsonschema2md/commit/2dbca6ff7d29935449d237ce9e7bdbe1cb676778))
80* **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92)
81* **traverseschema.js:** skip generating files for certain keywords in the schema ([fc50969](https://github.com/adobe/jsonschema2md/commit/fc50969426fd2ed0b55752f6c58d9246a22e309c))
82
83
84### BREAKING CHANGES
85
86* **traverseschema.js:** The extranious files, if they have some other value, will not be generated and
87there is no mechanism to continue to g
88
89## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2021-01-21)
90
91
92### Bug Fixes
93
94* **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c))
95* **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3))
96* **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092))
97* **deps:** update dependency js-yaml to v4 ([2dbca6f](https://github.com/adobe/jsonschema2md/commit/2dbca6ff7d29935449d237ce9e7bdbe1cb676778))
98* **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92)
99
100## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2021-01-02)
101
102
103### Bug Fixes
104
105* **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c))
106* **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3))
107* **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092))
108* **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92)
109
110## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-19)
111
112
113### Bug Fixes
114
115* **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c))
116* **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3))
117* **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092))
118* **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92)
119
120## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-15)
121
122
123### Bug Fixes
124
125* **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c))
126* **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3))
127* **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092))
128* **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92)
129
130## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-15)
131
132
133### Bug Fixes
134
135* **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c))
136* **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3))
137* **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92)
138
139## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-15)
140
141
142### Bug Fixes
143
144* **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c))
145* **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3))
146* **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92)
147
148## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-14)
149
150
151### Bug Fixes
152
153* **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c))
154* **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3))
155* **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92)
156
157## [4.2.1](https://github.com/adobe/jsonschema2md/compare/v4.2.0...v4.2.1) (2020-10-21)
158
159
160### Bug Fixes
161
162* **lib/markdownbuilder.js:** propTable property anchor link generated with github-slugger ([9883b8f](https://github.com/adobe/jsonschema2md/commit/9883b8f))
163
164# [4.2.0](https://github.com/adobe/jsonschema2md/compare/v4.1.6...v4.2.0) (2020-09-01)
165
166
167### Features
168
169* **markdownbuilder:** create an option to skip any property in markdown [#243](https://github.com/adobe/jsonschema2md/issues/243) ([56b7a2f](https://github.com/adobe/jsonschema2md/commit/56b7a2f))
170
171## [4.1.6](https://github.com/adobe/jsonschema2md/compare/v4.1.5...v4.1.6) (2020-07-31)
172
173
174### Bug Fixes
175
176* **markdown:** correcly show type of nullable types in header ([53c1a0b](https://github.com/adobe/jsonschema2md/commit/53c1a0b)), closes [#237](https://github.com/adobe/jsonschema2md/issues/237)
177
178## [4.1.5](https://github.com/adobe/jsonschema2md/compare/v4.1.4...v4.1.5) (2020-06-22)
179
180
181### Bug Fixes
182
183* **deps:** npm audit fix ([2be8a58](https://github.com/adobe/jsonschema2md/commit/2be8a58))
184* **markdown:** avoid ambiguities around property names ([a4543c4](https://github.com/adobe/jsonschema2md/commit/a4543c4)), closes [#232](https://github.com/adobe/jsonschema2md/issues/232)
185
186## [4.1.4](https://github.com/adobe/jsonschema2md/compare/v4.1.3...v4.1.4) (2020-06-22)
187
188
189### Bug Fixes
190
191* definition object defintions based on proplist structure ([2fb9fc5](https://github.com/adobe/jsonschema2md/commit/2fb9fc5)), closes [#228](https://github.com/adobe/jsonschema2md/issues/228)
192
193## [4.1.3](https://github.com/adobe/jsonschema2md/compare/v4.1.2...v4.1.3) (2020-06-04)
194
195
196### Bug Fixes
197
198* moved definitions to bottom of output file ([1b27fff](https://github.com/adobe/jsonschema2md/commit/1b27fff)), closes [#226](https://github.com/adobe/jsonschema2md/issues/226)
199
200## [4.1.2](https://github.com/adobe/jsonschema2md/compare/v4.1.1...v4.1.2) (2020-04-23)
201
202
203### Bug Fixes
204
205* **lib/index.js:** made -h/--header a boolean arg ([5ba2719](https://github.com/adobe/jsonschema2md/commit/5ba2719)), closes [#209](https://github.com/adobe/jsonschema2md/issues/209)
206
207## [4.1.1](https://github.com/adobe/jsonschema2md/compare/v4.1.0...v4.1.1) (2020-04-14)
208
209
210### Bug Fixes
211
212* **deps:** npm audit fix ([b13ab35](https://github.com/adobe/jsonschema2md/commit/b13ab35))
213* **enum:** fix doc generation for enums that contain arrays ([667a106](https://github.com/adobe/jsonschema2md/commit/667a106)), closes [#219](https://github.com/adobe/jsonschema2md/issues/219)
214
215# [4.1.0](https://github.com/adobe/jsonschema2md/compare/v4.0.13...v4.1.0) (2020-03-05)
216
217
218### Features
219
220* **examples:** enable examples to be formatted in YAML using command line option `-f yaml` ([01119ba](https://github.com/adobe/jsonschema2md/commit/01119ba))
221
222## [4.0.13](https://github.com/adobe/jsonschema2md/compare/v4.0.12...v4.0.13) (2020-01-31)
223
224
225### Bug Fixes
226
227* **i18n:** update German translations ([8cf38e4](https://github.com/adobe/jsonschema2md/commit/8cf38e4))
228
229## [4.0.12](https://github.com/adobe/jsonschema2md/compare/v4.0.11...v4.0.12) (2020-01-30)
230
231
232### Bug Fixes
233
234* dont use backslash for URLs on windows ([5149522](https://github.com/adobe/jsonschema2md/commit/5149522)), closes [#211](https://github.com/adobe/jsonschema2md/issues/211)
235
236## [4.0.11](https://github.com/adobe/jsonschema2md/compare/v4.0.10...v4.0.11) (2020-01-26)
237
238
239### Bug Fixes
240
241* **package:** fix & clean up dependencies ([890e86d](https://github.com/adobe/jsonschema2md/commit/890e86d)), closes [#210](https://github.com/adobe/jsonschema2md/issues/210)
242
243## [4.0.10](https://github.com/adobe/jsonschema2md/compare/v4.0.9...v4.0.10) (2020-01-21)
244
245
246### Bug Fixes
247
248* **deps:** pin es2015-i18n-tag version ([c531b50](https://github.com/adobe/jsonschema2md/commit/c531b50)), closes [#207](https://github.com/adobe/jsonschema2md/issues/207)
249
250## [4.0.9](https://github.com/adobe/jsonschema2md/compare/v4.0.8...v4.0.9) (2020-01-20)
251
252
253### Bug Fixes
254
255* **markdown:** prevent unescaped objects in markdown AST ([87d709a](https://github.com/adobe/jsonschema2md/commit/87d709a)), closes [#201](https://github.com/adobe/jsonschema2md/issues/201)
256
257## [4.0.8](https://github.com/adobe/jsonschema2md/compare/v4.0.7...v4.0.8) (2020-01-15)
258
259
260### Bug Fixes
261
262* **index.js:** -x flag is not working properly for the suppression case ([d929d9b](https://github.com/adobe/jsonschema2md/commit/d929d9b))
263
264## [4.0.7](https://github.com/adobe/jsonschema2md/compare/v4.0.6...v4.0.7) (2020-01-14)
265
266
267### Bug Fixes
268
269* **markdown:** increase robustness when using format as a property name ([cda0bec](https://github.com/adobe/jsonschema2md/commit/cda0bec)), closes [#198](https://github.com/adobe/jsonschema2md/issues/198)
270
271## [4.0.6](https://github.com/adobe/jsonschema2md/compare/v4.0.5...v4.0.6) (2020-01-14)
272
273
274### Bug Fixes
275
276* **markdown:** catch error when using `title` as a property name ([b4b8855](https://github.com/adobe/jsonschema2md/commit/b4b8855))
277
278## [4.0.5](https://github.com/adobe/jsonschema2md/compare/v4.0.4...v4.0.5) (2020-01-14)
279
280
281### Bug Fixes
282
283* **slugger:** fix slugger crash due to title property ([4f0ab31](https://github.com/adobe/jsonschema2md/commit/4f0ab31)), closes [#196](https://github.com/adobe/jsonschema2md/issues/196)
284
285## [4.0.4](https://github.com/adobe/jsonschema2md/compare/v4.0.3...v4.0.4) (2020-01-14)
286
287
288### Bug Fixes
289
290* **cli:** do not exit after creating readme.md ([cb7d012](https://github.com/adobe/jsonschema2md/commit/cb7d012))
291* **cli:** make the -n or --no-readme option work again ([3c63c03](https://github.com/adobe/jsonschema2md/commit/3c63c03))
292* **loader:** guard against endless wrapping ([dd1f7f6](https://github.com/adobe/jsonschema2md/commit/dd1f7f6)), closes [#194](https://github.com/adobe/jsonschema2md/issues/194)
293
294## [4.0.3](https://github.com/adobe/jsonschema2md/compare/v4.0.2...v4.0.3) (2020-01-09)
295
296
297### Bug Fixes
298
299* **schema:** do not recurse endlessly when writing cyclic schemas ([297f0d5](https://github.com/adobe/jsonschema2md/commit/297f0d5)), closes [#185](https://github.com/adobe/jsonschema2md/issues/185)
300
301## [4.0.2](https://github.com/adobe/jsonschema2md/compare/v4.0.1...v4.0.2) (2019-12-20)
302
303
304### Bug Fixes
305
306* **cli:** fix `traverse` function when called from CLI ([f211375](https://github.com/adobe/jsonschema2md/commit/f211375))
307
308## [4.0.1](https://github.com/adobe/jsonschema2md/compare/v4.0.0...v4.0.1) (2019-12-20)
309
310
311### Bug Fixes
312
313* **titles:** more robust handling of title generation for untitled schemas ([c546a28](https://github.com/adobe/jsonschema2md/commit/c546a28)), closes [#185](https://github.com/adobe/jsonschema2md/issues/185)
314* **traversal:** fix endless loop in schema traversal ([af85c59](https://github.com/adobe/jsonschema2md/commit/af85c59)), closes [#185](https://github.com/adobe/jsonschema2md/issues/185)
315
316# [4.0.0](https://github.com/adobe/jsonschema2md/compare/v3.3.1...v4.0.0) (2019-12-16)
317
318
319### Bug Fixes
320
321* **i18n:** use correct file name format ([43a74f4](https://github.com/adobe/jsonschema2md/commit/43a74f4))
322* **markdown:** constraint values can be zero now ([2e057fd](https://github.com/adobe/jsonschema2md/commit/2e057fd))
323* **markdown:** handle null as a constant value ([e652e11](https://github.com/adobe/jsonschema2md/commit/e652e11))
324* **proxy:** remove logging statements ([616a1d9](https://github.com/adobe/jsonschema2md/commit/616a1d9))
325* **schemas:** remove references going nowhere ([2186142](https://github.com/adobe/jsonschema2md/commit/2186142))
326
327
328### Build System
329
330* **dependencies:** remove unused dependencies ([dbc9192](https://github.com/adobe/jsonschema2md/commit/dbc9192))
331
332
333### Code Refactoring
334
335* **cli:** remove bluebird, lodash, simplify arg parsing ([b6b1822](https://github.com/adobe/jsonschema2md/commit/b6b1822))
336
337
338### Continuous Integration
339
340* **test:** require node 10 ([ba4a947](https://github.com/adobe/jsonschema2md/commit/ba4a947))
341
342
343### Documentation
344
345* **changelog:** mention changes for v4 ([4dfe90c](https://github.com/adobe/jsonschema2md/commit/4dfe90c)), closes [#126](https://github.com/adobe/jsonschema2md/issues/126) [#174](https://github.com/adobe/jsonschema2md/issues/174) [#72](https://github.com/adobe/jsonschema2md/issues/72) [#73](https://github.com/adobe/jsonschema2md/issues/73) [#94](https://github.com/adobe/jsonschema2md/issues/94) [#52](https://github.com/adobe/jsonschema2md/issues/52) [#20](https://github.com/adobe/jsonschema2md/issues/20) [#125](https://github.com/adobe/jsonschema2md/issues/125) [#177](https://github.com/adobe/jsonschema2md/issues/177) [#34](https://github.com/adobe/jsonschema2md/issues/34) [#123](https://github.com/adobe/jsonschema2md/issues/123)
346
347
348### Features
349
350* **cli:** generate JSON schema output ([dd18f3b](https://github.com/adobe/jsonschema2md/commit/dd18f3b)), closes [#176](https://github.com/adobe/jsonschema2md/issues/176)
351* **formats:** add support for formats: json-pointer, relative-json-pointer, regex, and uri-template ([689c158](https://github.com/adobe/jsonschema2md/commit/689c158))
352* **i18n:** new internationalization system ([1a664de](https://github.com/adobe/jsonschema2md/commit/1a664de))
353* **i18n:** provide complete en_US translation ([5eb0c89](https://github.com/adobe/jsonschema2md/commit/5eb0c89))
354* **markdown:** add header surpression ([6225b9f](https://github.com/adobe/jsonschema2md/commit/6225b9f))
355* **markdown:** add support for `default` keyword ([72a0fde](https://github.com/adobe/jsonschema2md/commit/72a0fde))
356* **markdown:** add support for comments ([07bb52f](https://github.com/adobe/jsonschema2md/commit/07bb52f))
357* **markdown:** add YAML frontmatter support ([4df92e6](https://github.com/adobe/jsonschema2md/commit/4df92e6))
358* **markdown:** create and write markdown ([e521541](https://github.com/adobe/jsonschema2md/commit/e521541))
359* **markdown:** generate additional detail ([cc07df2](https://github.com/adobe/jsonschema2md/commit/cc07df2))
360* **markdown:** generate header again ([011427c](https://github.com/adobe/jsonschema2md/commit/011427c))
361* **markdown:** generate some property details ([fa34cf1](https://github.com/adobe/jsonschema2md/commit/fa34cf1))
362* **markdown:** generate type details ([c9f19e1](https://github.com/adobe/jsonschema2md/commit/c9f19e1))
363* **markdown:** highlight keyword usage for documentation ([d35e4ed](https://github.com/adobe/jsonschema2md/commit/d35e4ed)), closes [#100](https://github.com/adobe/jsonschema2md/issues/100)
364* **markdown:** list nested schemas in README ([608674b](https://github.com/adobe/jsonschema2md/commit/608674b))
365* **markdown:** list nested schemas in README ([87e8489](https://github.com/adobe/jsonschema2md/commit/87e8489))
366* **markdown:** show examples ([c8e8dfa](https://github.com/adobe/jsonschema2md/commit/c8e8dfa))
367* **markdown:** show extensibility and abstraction in header ([90a9a8e](https://github.com/adobe/jsonschema2md/commit/90a9a8e))
368* **markdown:** show id and status in header ([08e1923](https://github.com/adobe/jsonschema2md/commit/08e1923))
369* **markdown:** show id and status in header ([b6fcf53](https://github.com/adobe/jsonschema2md/commit/b6fcf53))
370* **markdown:** show join types ([12af018](https://github.com/adobe/jsonschema2md/commit/12af018))
371* **markdown:** show some info about properties, switch i18n library ([f8a32df](https://github.com/adobe/jsonschema2md/commit/f8a32df))
372* **markdown:** show type, link, additional and custom properties in header ([eff129a](https://github.com/adobe/jsonschema2md/commit/eff129a))
373* **markdown:** show value constraints ([515969c](https://github.com/adobe/jsonschema2md/commit/515969c))
374* **markdown:** support item arrays and additionalItems ([c9fbcdf](https://github.com/adobe/jsonschema2md/commit/c9fbcdf)), closes [#31](https://github.com/adobe/jsonschema2md/issues/31)
375* **markdown:** support patternProperties and additionalProperties ([1386ee3](https://github.com/adobe/jsonschema2md/commit/1386ee3)), closes [#95](https://github.com/adobe/jsonschema2md/issues/95) [#180](https://github.com/adobe/jsonschema2md/issues/180)
376* **proxy:** generate meta information ([ac65ac6](https://github.com/adobe/jsonschema2md/commit/ac65ac6))
377* **proxy:** generate slugs ([eacbf38](https://github.com/adobe/jsonschema2md/commit/eacbf38))
378* **proxy:** resolve references ([4cea068](https://github.com/adobe/jsonschema2md/commit/4cea068))
379* **readme:** generate readme again ([d6b9e5e](https://github.com/adobe/jsonschema2md/commit/d6b9e5e))
380* **readme:** mention the most common schema version ([fc583d7](https://github.com/adobe/jsonschema2md/commit/fc583d7))
381* **schema:** add full support for "A Vocabulary for the Contents of String-Encoded Data" ([96ca3a6](https://github.com/adobe/jsonschema2md/commit/96ca3a6))
382* **schema:** add support for keyword `$defs` ([70b63c8](https://github.com/adobe/jsonschema2md/commit/70b63c8))
383* **schema:** add support for keyword `deprecated` ([934b856](https://github.com/adobe/jsonschema2md/commit/934b856))
384* **schema:** add support for readOnly and writeOnly schemas and properties ([7452882](https://github.com/adobe/jsonschema2md/commit/7452882))
385
386
387### BREAKING CHANGES
388
389* **changelog:** 
390* **i18n:** The file format for the i18n files has changed
391
392You can now specify the language to use using `-l` and `jsonschema2md` will pick up the correct language configuration.
393* **test:** Node 8 is no longer supported
394* **dependencies:** Removes the JSON schema validation feature entirely
395* **cli:** Repaces lodash with ferrum, removed bluebird, changes the meaning of `--schema-out` or `-x` to be no longer relative to output dir
396
397The `--schema-out` or `-x` command line option is no longer relative to the output path (specified with `-o` or `--out`)
398
399---
400
401# Note about Version 4.0
402
403`jsonschema2md` v4.0.0 has been a major rewrite that changes output format, command line parameters, i18n templates in order to increase the [coverage of the JSON Schema specification](schemasupport.md) and to make the project more maintainable.
404
405The JSON Schema validation functionality has been dropped entirely, as it is easier to just use `ajv` for that directly.
406
407---
408
409## [3.3.1](https://github.com/adobe/jsonschema2md/compare/v3.3.0...v3.3.1) (2019-09-18)
410
411
412### Bug Fixes
413
414* **package:** update @adobe/helix-log to version 2.0.0 ([33792f6](https://github.com/adobe/jsonschema2md/commit/33792f6))
415
416# [3.3.0](https://github.com/adobe/jsonschema2md/compare/v3.2.0...v3.3.0) (2019-08-26)
417
418
419### Features
420
421* allow display of custom attributes in the property description ([0634309](https://github.com/adobe/jsonschema2md/commit/0634309)), closes [#151](https://github.com/adobe/jsonschema2md/issues/151)
422
423# [3.2.0](https://github.com/adobe/jsonschema2md/compare/v3.1.2...v3.2.0) (2019-08-20)
424
425
426### Features
427
428* disable header.ejs using console args ([104452f](https://github.com/adobe/jsonschema2md/commit/104452f)), closes [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153)
429
430## [3.1.2](https://github.com/adobe/jsonschema2md/compare/v3.1.1...v3.1.2) (2019-08-07)
431
432
433### Bug Fixes
434
435* always output POSIX paths ([3c1c42c](https://github.com/adobe/jsonschema2md/commit/3c1c42c))
436* fix error logging from submodules ([dc634b2](https://github.com/adobe/jsonschema2md/commit/dc634b2))
437
438## [3.1.1](https://github.com/adobe/jsonschema2md/compare/v3.1.0...v3.1.1) (2019-07-31)
439
440
441### Bug Fixes
442
443* **i18n init:** moved the i18n init part to the cli.js ([5e37d2d](https://github.com/adobe/jsonschema2md/commit/5e37d2d)), closes [#157](https://github.com/adobe/jsonschema2md/issues/157)
444* **markdownwriter.js:** use path function to resolve the path ([5fe7db2](https://github.com/adobe/jsonschema2md/commit/5fe7db2)), closes [#157](https://github.com/adobe/jsonschema2md/issues/157)
445
446# [3.1.0](https://github.com/adobe/jsonschema2md/compare/v3.0.1...v3.1.0) (2019-07-30)
447
448
449### Features
450
451* **i18n:** enable localization of all strings, provide en as default language ([daa58a2](https://github.com/adobe/jsonschema2md/commit/daa58a2)), closes [#143](https://github.com/adobe/jsonschema2md/issues/143)
452
453## [3.0.1](https://github.com/adobe/jsonschema2md/compare/v3.0.0...v3.0.1) (2019-07-29)
454
455
456### Bug Fixes
457
458* **schema.js:** fix $ref not being resolved when nested deeper than once within an object ([6eb73c3](https://github.com/adobe/jsonschema2md/commit/6eb73c3)), closes [#155](https://github.com/adobe/jsonschema2md/issues/155)
459
460# [3.0.0](https://github.com/adobe/jsonschema2md/compare/v2.1.2...v3.0.0) (2019-07-24)
461
462
463### Bug Fixes
464
465* **cli:** fix breaking changes to readdirp API ([5150f3f](https://github.com/adobe/jsonschema2md/commit/5150f3f))
466* **package:** update readdirp to version 3.1.1 ([05cd51e](https://github.com/adobe/jsonschema2md/commit/05cd51e)), closes [#127](https://github.com/adobe/jsonschema2md/issues/127)
467
468
469### Build System
470
471* **package:** require minimum node version: 8 ([a9ec935](https://github.com/adobe/jsonschema2md/commit/a9ec935))
472
473
474### BREAKING CHANGES
475
476* **package:** Node 7 and lower are no longer supported, Node 8 is now the minimum version
477
478## [2.1.2](https://github.com/adobe/jsonschema2md/compare/v2.1.1...v2.1.2) (2019-07-19)
479
480
481### Bug Fixes
482
483* Fix `$ref` within nested objects not generating correct markdown ([b8c9a49](https://github.com/adobe/jsonschema2md/commit/b8c9a49)), closes [#136](https://github.com/adobe/jsonschema2md/issues/136)
484
485## [2.1.1](https://github.com/adobe/jsonschema2md/compare/v2.1.0...v2.1.1) (2019-05-29)
486
487
488### Bug Fixes
489
490* **package:** update async to version 3.0.1 ([4ffa21e](https://github.com/adobe/jsonschema2md/commit/4ffa21e))
491
492# [2.1.0](https://github.com/adobe/jsonschema2md/compare/v2.0.0...v2.1.0) (2019-04-30)
493
494
495### Features
496
497* Apply prettier to generated markdown files for improved formatting ([0e8bde4](https://github.com/adobe/jsonschema2md/commit/0e8bde4))
498
499# [2.0.0](https://github.com/adobe/jsonschema2md/compare/v1.0.0...v2.0.0) (2019-03-26)
500
501
502### Bug Fixes
503
504* **release:** Fix release process ([6bf5a10](https://github.com/adobe/jsonschema2md/commit/6bf5a10)), closes [#109](https://github.com/adobe/jsonschema2md/issues/109) [#90](https://github.com/adobe/jsonschema2md/issues/90)
505
506
507### BREAKING CHANGES
508
509* **release:** Major version bump
510
511# 1.0.0 (2019-03-18)
512
513
514### Bug Fixes
515
516* **ci:** use node8 for releases ([9c2a186](https://github.com/adobe/jsonschema2md/commit/9c2a186))