1
1
# Welcome to JSON Schema
2
- [ ![ Contributor Covenant] ( https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg )] ( https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md ) [ ![ Project Status: Active – The project has reached a stable, usable state and is being actively developed.] ( https://www.repostatus.org/badges/latest/active.svg )] ( https://www.repostatus.org/#active ) [ ![ Financial Contributors on Open Collective] ( https://opencollective.com/json-schema/all/badge.svg?label=financial+contributors )] ( https://opencollective.com/json-schema )
2
+ [ ![ Contributor Covenant] ( https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg )] ( https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md )
3
+ [ ![ Project Status: Active – The project has reached a stable, usable state and is being actively developed.] ( https://www.repostatus.org/badges/latest/active.svg )] ( https://www.repostatus.org/#active )
4
+ [ ![ Financial Contributors on Open Collective] ( https://opencollective.com/json-schema/all/badge.svg?label=financial+contributors )] ( https://opencollective.com/json-schema )
3
5
4
- JSON Schema is a vocabulary that allows you to validate, annotate, and manipulate JSON documents.
6
+ JSON Schema is a vocabulary that allows you to validate, annotate, and
7
+ manipulate JSON documents.
5
8
6
- This repository contains the sources for the ** work in progress** of the next set of JSON Schema IETF Internet Draft (I-D) documents.
7
- For the latest released I-Ds, please see the [ Specification page] ( http://json-schema.org/specification.html ) on the website.
9
+ This repository contains the sources for the ** work in progress** of the next
10
+ set of JSON Schema IETF Internet Draft (I-D) documents. For the latest released
11
+ I-Ds, please see the
12
+ [ Specification page] ( http://json-schema.org/specification.html ) on the website.
8
13
9
14
## Call for contributions and feedback
10
15
11
16
Reviews, comments and suggestions are most welcome!
12
17
Please read our [ guidelines for contributing] ( CONTRIBUTING.md ) .
13
18
14
19
## Status
15
- For the current status of issues and pull requests, please see the following labels
16
20
17
- [ ![ Available ] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20Available.svg?color=brightgreen )] ( https://github.com/json-schema-org/json-schema-spec/issues?q=is%3Aopen+is%3Aissue+label%3A%22Status%3A+Available%22 ) [ ![ In Progress ] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20In%20Progress.svg )] ( https://github.com/json-schema-org/json-schema-spec/labels/Status:%20In%20Progress ) [ ![ Review Needed ] ( https://img.shields.io/github/ issues/json-schema-org/json-schema-spec/Status:%20Review%20Needed.svg )] ( https://github.com/json-schema-org/json-schema-spec/ labels/Status%3A%20Review%20Needed )
21
+ For the current status of issues and pull requests, please see the following labels
18
22
23
+ [ ![ Available] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20Available.svg?color=brightgreen )] ( https://github.com/json-schema-org/json-schema-spec/issues?q=is%3Aopen+is%3Aissue+label%3A%22Status%3A+Available%22 )
24
+ [ ![ In Progress] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20In%20Progress.svg )] ( https://github.com/json-schema-org/json-schema-spec/labels/Status:%20In%20Progress )
25
+ [ ![ Review Needed] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20Review%20Needed.svg )] ( https://github.com/json-schema-org/json-schema-spec/labels/Status%3A%20Review%20Needed )
19
26
[ ![ Critical] (https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20Critical.svg?color=critical
20
- )] ( https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Critical ) [ ![ High] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20High.svg?color=important )] ( https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20High ) [ ![ Medium] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20Medium.svg )] ( https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Medium ) [ ![ Low] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20Low.svg )] ( https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Low )
27
+ )] ( https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Critical )
28
+ [ ![ High] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20High.svg?color=important )] ( https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20High )
29
+ [ ![ Medium] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20Medium.svg )] ( https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Medium )
30
+ [ ![ Low] ( https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20Low.svg )] ( https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Low )
21
31
22
-
23
- Labels are assigned based on [ Sensible Github Labels] ( https://github.com/Relequestual/sensible-github-labels ) .
32
+ Labels are assigned based on
33
+ [ Sensible Github Labels] ( https://github.com/Relequestual/sensible-github-labels ) .
24
34
25
35
## Authoring and Building
26
36
27
37
### Specification
38
+
28
39
To build the spec files to HTML from the Markdown sources, run `npm run
29
- build-all`.
30
- You can also build each individually with ` npm run build -- filename .md `
31
- (Example: ` npm run build -- jsonschema-core.md ` ). You can also use wildcards to
32
- build multiple specs at the same time: ` npm run build -- jsonschema-*.md ` . The
33
- HTML files will be available in the ` web ` folder.
40
+ build-all`. You can also build each individually with
41
+ ` npm run build -- filename.md ` (Example: ` npm run build -- jsonschema-core .md ` ).
42
+ You can also use wildcards to build multiple specs at the same time:
43
+ ` npm run build -- jsonschema-*.md ` . The HTML files will be available in the
44
+ ` web ` folder.
34
45
35
46
The spec is built using [ Remark] ( https://remark.js.org/ ) , a markdown engine with
36
47
good support for plugins and lots of existing plugins we can use.
37
48
38
49
#### Plugins
50
+
39
51
The following is a not-necessarily-complete list of configured plugins and the
40
52
features they make available to you.
41
53
@@ -49,7 +61,7 @@ features they make available to you.
49
61
- [ remark-heading-id] ( https://github.com/imcuttle/remark-heading-id ) -- Adds
50
62
support for ` {#my-anchor} ` syntax to add an ` id ` to an element so it can be
51
63
referenced using URI fragment syntax.
52
- - [ remark-headings] ( /json-schema-org/json-schema-spec/blob/main/remark-headings.js )
64
+ - [ remark-headings] ( /json-schema-org/json-schema-spec/blob/main/build/ remark-headings.js )
53
65
-- A collection of enhancements for headings.
54
66
- Adds hierarchical section numbers to headings.
55
67
- Use the ` [Appendix] ` prefix on headings that should be numbered as an
@@ -58,21 +70,22 @@ features they make available to you.
58
70
- Example: ` #section-2-13 `
59
71
- Example: ` #appendix-a `
60
72
- Makes the heading a link utilizing its anchor
61
- - [ remark-reference-links] ( /json-schema-org/json-schema-spec/blob/main/remark-reference-link .js )
73
+ - [ remark-reference-links] ( /json-schema-org/json-schema-spec/blob/main/build/ remark-reference-links .js )
62
74
-- Adds new syntax for referencing a section of the spec using the section
63
75
number as the link text.
64
76
- Example:
65
77
``` markdown
66
78
## Foo {#foo}
67
79
68
80
## Bar
81
+
69
82
This is covered in {{foo}} // --> Renders to "This is covered in [Section 2.3](#foo)"
70
83
- Link text will use "Section" or "Appendix" as needed
71
84
```
72
- - [remark-table-of-contents](/json-schema-org/json-schema-spec/blob/main/remark-table-of-contents.js)
85
+ - [remark-table-of-contents](/json-schema-org/json-schema-spec/blob/main/build/ remark-table-of-contents.js)
73
86
-- Adds a table of contents in a section with a header called "Table of
74
87
Contents".
75
- - [remark-code-titles](/json-schema-org/json-schema-spec/blob/main/remark-code-titles.js)
88
+ - [remark-code-titles](/json-schema-org/json-schema-spec/blob/main/build/ remark-code-titles.js)
76
89
-- Add titles to code blocks
77
90
- Example:
78
91
```markdown
@@ -85,7 +98,7 @@ features they make available to you.
85
98
escaped characters. So, to get `My "quoted" title`, you would need to be
86
99
`"My \\\\"quoted\\\\" title"`.
87
100
- [remark-torchlight](https://github.com/torchlight-api/remark-torchlight) --
88
- Syntax highlighting and more using https://torchlight.dev. Features include
101
+ Syntax highlighting and more using < https://torchlight.dev> . Features include
89
102
line numbers and line highlighting.
90
103
- [remark-flexible-containers](https://github.com/ipikuka/remark-flexible-containers)
91
104
-- Add a callout box using the following syntax. Supported container types are
@@ -98,6 +111,7 @@ features they make available to you.
98
111
```
99
112
100
113
### Internet-Drafts
114
+
101
115
To build components that are being maintained as IETF Internet-Drafts, run
102
116
`make`. The Makefile will create the necessary Python venv for you as part of
103
117
the regular make target.
@@ -113,10 +127,10 @@ The version of "xml2rfc" that this project uses is updated by modifying
113
127
114
128
Descriptions of the xml2rfc, I-D documents, and RFC processes:
115
129
116
- * https://xml2rfc.tools.ietf.org/authoring/draft-mrose-writing-rfcs.html
117
- * https://www.ietf.org/tao.html
118
- * https://www.ietf.org/ietf-ftp/1id-guidelines.html
119
- * https://www.rfc-editor.org/rfc/rfc7322.txt
130
+ - < https://xml2rfc.tools.ietf.org/authoring/draft-mrose-writing-rfcs.html>
131
+ - < https://www.ietf.org/tao.html>
132
+ - < https://www.ietf.org/ietf-ftp/1id-guidelines.html>
133
+ - < https://www.rfc-editor.org/rfc/rfc7322.txt>
120
134
121
135
## Test suites
122
136
@@ -125,20 +139,24 @@ Conformance tests for JSON Schema and its vocabularies may be found
125
139
126
140
## The website
127
141
128
- The JSON Schema web site is at http://json-schema.org/
142
+ The JSON Schema web site is at < http://json-schema.org/>
129
143
130
144
The source for the website is [maintained in a separate repository](https://github.com/json-schema-org/website).
131
145
132
146
## Contributors
133
147
134
148
### Code Contributors
135
149
136
- This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
137
- <a href="https://github.com/json-schema-org/json-schema-spec/graphs/contributors"><img src="https://opencollective.com/json-schema/contributors.svg?width=890&button=false" /></a>
150
+ This project exists thanks to all the people who contribute.
151
+ [[Contribute](CONTRIBUTING.md)]. <a
152
+ href="https://github.com/json-schema-org/json-schema-spec/graphs/contributors"><img
153
+ src="https://opencollective.com/json-schema/contributors.svg?width=890&button=false"
154
+ /></a>
138
155
139
156
### Financial Contributors
140
157
141
158
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/json-schema/contribute)]
159
+
142
160
#### Sponsors
143
161
144
162
Here are our top sponsors. You could be next! [[Become a sponsor](https://opencollective.com/json-schema#sponsor)]
@@ -160,4 +178,5 @@ Here are our top sponsors. You could be next! [[Become a sponsor](https://openco
160
178
161
179
## License
162
180
163
- The contents of this repository are [licensed under](./LICENSE) either the BSD 3-clause license *or* the Academic Free License v3.0.
181
+ The contents of this repository are [licensed under](./LICENSE) either the BSD
182
+ 3-clause license *or* the Academic Free License v3.0.
0 commit comments