Skip to content

Commit f78a295

Browse files
gregsdennisjdesrosiers
authored andcommittedNov 13, 2024
lint readme
1 parent e1fc15b commit f78a295

File tree

1 file changed

+40
-22
lines changed

1 file changed

+40
-22
lines changed
 

‎README.md

+40-22
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
11
# 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)
35

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.
58

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.
813

914
## Call for contributions and feedback
1015

1116
Reviews, comments and suggestions are most welcome!
1217
Please read our [guidelines for contributing](CONTRIBUTING.md).
1318

1419
## Status
15-
For the current status of issues and pull requests, please see the following labels
1620

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
1822

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)
1926
[![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)
2131

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).
2434

2535
## Authoring and Building
2636

@@ -38,6 +48,7 @@ a [VSCode extension](https://github.com/remarkjs/vscode-remark) we can use to
3848
get linting an link checking while developing the spec.
3949

4050
#### Plugins
51+
4152
The following is a not-necessarily-complete list of configured plugins and the
4253
features they make available to you.
4354

@@ -51,7 +62,7 @@ features they make available to you.
5162
- [remark-heading-id](https://github.com/imcuttle/remark-heading-id) -- Adds
5263
support for `{#my-anchor}` syntax to add an `id` to an element so it can be
5364
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)
5566
-- A collection of enhancements for headings.
5667
- Adds hierarchical section numbers to headings.
5768
- Use the `%appendix%` prefix on headings that should be numbered as an
@@ -60,21 +71,22 @@ features they make available to you.
6071
- Example: `#section-2-13`
6172
- Example: `#appendix-a`
6273
- 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)
6475
-- Adds new syntax for referencing a section of the spec using the section
6576
number as the link text.
6677
- Example:
6778
```markdown
6879
## Foo {#foo}
6980

7081
## Bar
82+
7183
This is covered in {{foo}} // --> Renders to "This is covered in [Section 2.3](#foo)"
7284
- Link text will use "Section" or "Appendix" as needed
7385
```
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)
7587
-- Adds a table of contents in a section with a header called "Table of
7688
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)
7890
-- Add titles to code blocks
7991
- Example:
8092
```markdown
@@ -87,7 +99,7 @@ features they make available to you.
8799
escaped characters. So, to get `My "quoted" title`, you would need to be
88100
`"My \\\\"quoted\\\\" title"`.
89101
- [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
91103
line numbers and line highlighting.
92104
- [remark-flexible-containers](https://github.com/ipikuka/remark-flexible-containers)
93105
-- Add a callout box using the following syntax. Supported container types are
@@ -100,6 +112,7 @@ features they make available to you.
100112
```
101113

102114
### Internet-Drafts
115+
103116
To build components that are being maintained as IETF Internet-Drafts, run
104117
`make`. The Makefile will create the necessary Python venv for you as part of
105118
the regular make target.
@@ -115,10 +128,10 @@ The version of "xml2rfc" that this project uses is updated by modifying
115128

116129
Descriptions of the xml2rfc, I-D documents, and RFC processes:
117130

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>
122135

123136
## Test suites
124137

@@ -127,20 +140,24 @@ Conformance tests for JSON Schema and its vocabularies may be found
127140

128141
## The website
129142

130-
The JSON Schema web site is at http://json-schema.org/
143+
The JSON Schema web site is at <http://json-schema.org/>
131144

132145
The source for the website is [maintained in a separate repository](https://github.com/json-schema-org/website).
133146

134147
## Contributors
135148

136149
### Code Contributors
137150

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>
140156

141157
### Financial Contributors
142158

143159
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/json-schema/contribute)]
160+
144161
#### Sponsors
145162

146163
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
162179

163180
## License
164181

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

Comments
 (0)
Please sign in to comment.