Skip to content

Commit 4fcc97c

Browse files
committed
Fixes after renaming master to main
1 parent 40104da commit 4fcc97c

25 files changed

+308
-308
lines changed

.github/workflows/publish_to_pypi.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Publish to Pypi
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77

88
workflow_dispatch:
99
inputs:
@@ -30,5 +30,5 @@ jobs:
3030
with:
3131
project-name: json-schema-for-humans
3232
pypi-token: ${{ secrets.PYPI_TOKEN }}
33-
pre-release: ${{ github.ref != 'refs/heads/master' }}
34-
dry-run: ${{ github.ref != 'refs/heads/master' && github.event.inputs.publish != 'true' }}
33+
pre-release: ${{ github.ref != 'refs/heads/main' }}
34+
dry-run: ${{ github.ref != 'refs/heads/main' && github.event.inputs.publish != 'true' }}

.github/workflows/pythonpackage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Python package
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77

88
pull_request:
99
types: [ opened, synchronize, reopened ]

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Quickly generate a beautiful static HTML or Markdown page documenting a JSON sch
1111
- Support for JSON Schema Draft-07
1212
- Since the result is static, it is easier to host and faster to load
1313
- 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)
1515
- Anchor links, allow to send a user to a specific section of the documentation
1616
- Support for references (even circular!)
1717

@@ -22,7 +22,7 @@ pip install json-schema-for-humans
2222

2323
## Usage
2424

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/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)
2626

2727
They can be supplied in various ways:
2828
- 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`
6161
#### CLI options
6262

6363
#### --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).
6565

6666
Each parameter is in the format `--config parameter_name=parameter_value`. Example: `--config expand_buttons=true`. The parameter value must be valid JSON.
6767

@@ -163,7 +163,7 @@ Templates control the style of the generated documentation.
163163

164164
This is the default template. It uses Bootstrap along with minimal Javascript to allow for the following:
165165

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))
167167
- Conditional subschemas (`anyOf`, `oneOf`, `allOf`) are in tabbed sections
168168
- Anchor links will scroll to, expand, and animate the target section
169169
- Long descriptions are collapsed by default
@@ -189,7 +189,7 @@ On GitHub, this format is rendered directly when browsing code.
189189
A table of content is provided at the beginning of the file for easy navigation.
190190

191191
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)
193193

194194
Contributions are welcomed to improve it!
195195

docs/Configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,31 +38,31 @@ These parameters can be provided with a json or yaml file, through the CLI, or t
3838

3939
<details>
4040
<summary>Markdown without badge template - Click here to expand the rendered result...</summary>
41-
<a href="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+
<a href="https://github.com/coveooss/json-schema-for-humans/blob/main/docs/examples/examples_md_default/Configuration.md" target="_blank">Open it in github</a>
4242

4343
[examples/examples_md_default/Configuration.md](examples/examples_md_default/Configuration.md ':include')
4444
</details>
4545

4646

4747
<details>
4848
<summary>Markdown with badges template - Click here to expand the rendered result...</summary>
49-
<a href="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+
<a href="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>
5050

5151
[examples/examples_md_with_badges/Configuration.md](examples/examples_md_with_badges/Configuration.md ':include')
5252
</details>
5353

5454

5555
<details>
5656
<summary>Nested Markdown without badges template - Click here to expand the rendered result...</summary>
57-
<a href="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+
<a href="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>
5858

5959
[examples/examples_md_nested_default/Configuration.md](examples/examples_md_nested_default/Configuration.md ':include')
6060
</details>
6161

6262

6363
<details>
6464
<summary>Nested Markdown with badges template - Click here to expand the rendered result...</summary>
65-
<a href="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+
<a href="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>
6666

6767
[examples/examples_md_nested_with_badges/Configuration.md](examples/examples_md_nested_with_badges/Configuration.md ':include')
6868
</details>

0 commit comments

Comments
 (0)