You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Quickly generate a beautiful static HTML or Markdown page documenting a JSON sch
11
11
- Support for JSON Schema Draft-07
12
12
- Since the result is static, it is easier to host and faster to load
13
13
- HTML and Markdown output support
14
-
- Different templates to choose from. More details: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html#template_name) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_default/Configuration.md#template_name)
14
+
- Different templates to choose from. More details: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html#template_name) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_default/Configuration.md#template_name)
15
15
- Anchor links, allow to send a user to a specific section of the documentation
Options for generation of the doc are documented using the library itself: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_default/Configuration.md)
25
+
Options for generation of the doc are documented using the library itself: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_default/Configuration.md)
26
26
27
27
They can be supplied in various ways:
28
28
- Using a JSON or YAML configuration file with the CLI option `--config-file`
@@ -61,7 +61,7 @@ In a case where more than one schema is provided as input, `RESULT_FILE_OR_DIR`
61
61
#### CLI options
62
62
63
63
#### --config
64
-
Supply generation config parameters. The parameters are documented in the JSON schema `config_schema.json` at the root of the repo or see the generated doc: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_default/Configuration.md).
64
+
Supply generation config parameters. The parameters are documented in the JSON schema `config_schema.json` at the root of the repo or see the generated doc: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_default/Configuration.md).
65
65
66
66
Each parameter is in the format `--config parameter_name=parameter_value`. Example: `--config expand_buttons=true`. The parameter value must be valid JSON.
67
67
@@ -163,7 +163,7 @@ Templates control the style of the generated documentation.
163
163
164
164
This is the default template. It uses Bootstrap along with minimal Javascript to allow for the following:
165
165
166
-
- Properties are in expandable dynamic sections. You can include a button to expand or collapse all. (See doc: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html#expand_buttons) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_default/Configuration.md#expand_buttons))
166
+
- Properties are in expandable dynamic sections. You can include a button to expand or collapse all. (See doc: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html#expand_buttons) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_default/Configuration.md#expand_buttons))
167
167
- Conditional subschemas (`anyOf`, `oneOf`, `allOf`) are in tabbed sections
168
168
- Anchor links will scroll to, expand, and animate the target section
169
169
- Long descriptions are collapsed by default
@@ -189,7 +189,7 @@ On GitHub, this format is rendered directly when browsing code.
189
189
A table of content is provided at the beginning of the file for easy navigation.
190
190
191
191
You can display some important information as badge using an option.
192
-
See doc: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html#template_md_options_badge_as_image) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_default/Configuration.md#template_md_options_badge_as_image)
192
+
See doc: [HTML version](https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html#template_md_options_badge_as_image) - [Markdown version](https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_default/Configuration.md#template_md_options_badge_as_image)
Copy file name to clipboardExpand all lines: docs/Configuration.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -38,31 +38,31 @@ These parameters can be provided with a json or yaml file, through the CLI, or t
38
38
39
39
<details>
40
40
<summary>Markdown without badge template - Click here to expand the rendered result...</summary>
41
-
<ahref="https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_default/Configuration.md"target="_blank">Open it in github</a>
41
+
<ahref="https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_default/Configuration.md"target="_blank">Open it in github</a>
<summary>Markdown with badges template - Click here to expand the rendered result...</summary>
49
-
<ahref="https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_with_badges/Configuration.md"target="_blank">Open it in github</a>
49
+
<ahref="https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_with_badges/Configuration.md"target="_blank">Open it in github</a>
<summary>Nested Markdown without badges template - Click here to expand the rendered result...</summary>
57
-
<ahref="https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_nested_default/Configuration.md"target="_blank">Open it in github</a>
57
+
<ahref="https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_nested_default/Configuration.md"target="_blank">Open it in github</a>
<summary>Nested Markdown with badges template - Click here to expand the rendered result...</summary>
65
-
<ahref="https://github.com/coveooss/json-schema-for-humans/blob/master/docs/examples/examples_md_nested_with_badges/Configuration.md"target="_blank">Open it in github</a>
65
+
<ahref="https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_nested_with_badges/Configuration.md"target="_blank">Open it in github</a>
0 commit comments