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
@@ -38,6 +48,7 @@ a [VSCode extension](https://github.com/remarkjs/vscode-remark) we can use to
38
48
get linting an link checking while developing the spec.
39
49
40
50
#### Plugins
51
+
41
52
The following is a not-necessarily-complete list of configured plugins and the
42
53
features they make available to you.
43
54
@@ -51,7 +62,7 @@ features they make available to you.
51
62
- [ remark-heading-id] ( https://github.com/imcuttle/remark-heading-id ) -- Adds
52
63
support for ` {#my-anchor} ` syntax to add an ` id ` to an element so it can be
53
64
referenced using URI fragment syntax.
54
- - [ remark-headings] ( /json-schema-org/json-schema-spec/blob/main/remark-headings.js )
65
+ - [ remark-headings] ( /json-schema-org/json-schema-spec/blob/main/build/ remark-headings.js )
55
66
-- A collection of enhancements for headings.
56
67
- Adds hierarchical section numbers to headings.
57
68
- Use the ` %appendix% ` prefix on headings that should be numbered as an
@@ -60,21 +71,22 @@ features they make available to you.
60
71
- Example: ` #section-2-13 `
61
72
- Example: ` #appendix-a `
62
73
- Makes the heading a link utilizing its anchor
63
- - [ remark-reference-links] ( /json-schema-org/json-schema-spec/blob/main/remark-reference-link .js )
74
+ - [ remark-reference-links] ( /json-schema-org/json-schema-spec/blob/main/build/ remark-reference-links .js )
64
75
-- Adds new syntax for referencing a section of the spec using the section
65
76
number as the link text.
66
77
- Example:
67
78
``` markdown
68
79
## Foo {#foo}
69
80
70
81
## Bar
82
+
71
83
This is covered in {{foo}} // --> Renders to "This is covered in [Section 2.3](#foo)"
72
84
- Link text will use "Section" or "Appendix" as needed
73
85
```
74
- - [remark-table-of-contents](/json-schema-org/json-schema-spec/blob/main/remark-table-of-contents.js)
86
+ - [remark-table-of-contents](/json-schema-org/json-schema-spec/blob/main/build/ remark-table-of-contents.js)
75
87
-- Adds a table of contents in a section with a header called "Table of
76
88
Contents".
77
- - [remark-code-titles](/json-schema-org/json-schema-spec/blob/main/remark-code-titles.js)
89
+ - [remark-code-titles](/json-schema-org/json-schema-spec/blob/main/build/ remark-code-titles.js)
78
90
-- Add titles to code blocks
79
91
- Example:
80
92
```markdown
@@ -87,7 +99,7 @@ features they make available to you.
87
99
escaped characters. So, to get `My "quoted" title`, you would need to be
88
100
`"My \\\\"quoted\\\\" title"`.
89
101
- [remark-torchlight](https://github.com/torchlight-api/remark-torchlight) --
90
- Syntax highlighting and more using https://torchlight.dev. Features include
102
+ Syntax highlighting and more using < https://torchlight.dev> . Features include
91
103
line numbers and line highlighting.
92
104
- [remark-flexible-containers](https://github.com/ipikuka/remark-flexible-containers)
93
105
-- Add a callout box using the following syntax. Supported container types are
@@ -100,6 +112,7 @@ features they make available to you.
100
112
```
101
113
102
114
### Internet-Drafts
115
+
103
116
To build components that are being maintained as IETF Internet-Drafts, run
104
117
`make`. The Makefile will create the necessary Python venv for you as part of
105
118
the regular make target.
@@ -115,10 +128,10 @@ The version of "xml2rfc" that this project uses is updated by modifying
115
128
116
129
Descriptions of the xml2rfc, I-D documents, and RFC processes:
117
130
118
- * https://xml2rfc.tools.ietf.org/authoring/draft-mrose-writing-rfcs.html
119
- * https://www.ietf.org/tao.html
120
- * https://www.ietf.org/ietf-ftp/1id-guidelines.html
121
- * https://www.rfc-editor.org/rfc/rfc7322.txt
131
+ - < https://xml2rfc.tools.ietf.org/authoring/draft-mrose-writing-rfcs.html>
132
+ - < https://www.ietf.org/tao.html>
133
+ - < https://www.ietf.org/ietf-ftp/1id-guidelines.html>
134
+ - < https://www.rfc-editor.org/rfc/rfc7322.txt>
122
135
123
136
## Test suites
124
137
@@ -127,20 +140,24 @@ Conformance tests for JSON Schema and its vocabularies may be found
127
140
128
141
## The website
129
142
130
- The JSON Schema web site is at http://json-schema.org/
143
+ The JSON Schema web site is at < http://json-schema.org/>
131
144
132
145
The source for the website is [maintained in a separate repository](https://github.com/json-schema-org/website).
133
146
134
147
## Contributors
135
148
136
149
### Code Contributors
137
150
138
- This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
139
- <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>
151
+ This project exists thanks to all the people who contribute.
152
+ [[Contribute](CONTRIBUTING.md)]. <a
153
+ href="https://github.com/json-schema-org/json-schema-spec/graphs/contributors"><img
154
+ src="https://opencollective.com/json-schema/contributors.svg?width=890&button=false"
155
+ /></a>
140
156
141
157
### Financial Contributors
142
158
143
159
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/json-schema/contribute)]
160
+
144
161
#### Sponsors
145
162
146
163
Here are our top sponsors. You could be next! [[Become a sponsor](https://opencollective.com/json-schema#sponsor)]
@@ -162,4 +179,5 @@ Here are our top sponsors. You could be next! [[Become a sponsor](https://openco
162
179
163
180
## License
164
181
165
- The contents of this repository are [licensed under](./LICENSE) either the BSD 3-clause license *or* the Academic Free License v3.0.
182
+ The contents of this repository are [licensed under](./LICENSE) either the BSD
183
+ 3-clause license *or* the Academic Free License v3.0.
0 commit comments