Skip to content

Commit cc3c05d

Browse files
davidlehnBigBlueHat
authored andcommitted
Convert README to markdown.
- Convert README from reStructuredText to Markdown. - The reStructuredText format still works, and was a fine choice back in 2010(!) but Markdown is more common for READMEs like this today.
1 parent 3418194 commit cc3c05d

File tree

2 files changed

+24
-19
lines changed

2 files changed

+24
-19
lines changed

.eleventy.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ module.exports = function(eleventyConfig) {
3333
eleventyConfig.addPassthroughCopy('utils');
3434
eleventyConfig.ignores.add('CONTRIBUTING.md');
3535
eleventyConfig.ignores.add('LICENSE.md');
36-
eleventyConfig.ignores.add('README.rst');
36+
eleventyConfig.ignores.add('README.md');
3737
eleventyConfig.ignores.add('benchmarks/README.md');
3838
eleventyConfig.ignores.add('contexts/person.html');
3939
eleventyConfig.ignores.add('examples');

README.rst renamed to README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1+
json-ld.org
2+
===========
3+
14
Introduction
25
------------
36

4-
.. image:: https://badges.gitter.im/json-ld/json-ld.org.svg
5-
:alt: Join the chat at https://gitter.im/json-ld/json-ld.org
6-
:target: https://gitter.im/json-ld/json-ld.org?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
7+
[![Join the chat at https://gitter.im/json-ld/json-ld.org](https://badges.gitter.im/json-ld/json-ld.org.svg)](https://gitter.im/json-ld/json-ld.org)
8+
9+
This is the source for the https://json-ld.org/ website.
710

811
JSON-LD (JavaScript Object Notation for Linking Data) is a lightweight Linked
912
Data format. It is easy for humans to read and write. It is easy for machines
@@ -15,21 +18,23 @@ These properties make JSON-LD an ideal Linked Data interchange language for
1518
JavaScript environments, Web services, and unstructured databases such as
1619
CouchDB and MongoDB.
1720

18-
If you are already using JSON-LD, add yourself to the `list of users`_ in our wiki.
21+
If you are already using JSON-LD, add yourself to the [list of users][] in our wiki.
1922

2023

2124
A Simple Example
2225
----------------
2326

2427
A simple example of a JSON object with added semantics::
2528

26-
{
27-
"@context": "https://json-ld.org/contexts/person.jsonld",
28-
"@id": "http://dbpedia.org/resource/John_Lennon",
29-
"name": "John Lennon",
30-
"born": "1940-10-09",
31-
"spouse": "http://dbpedia.org/resource/Cynthia_Lennon"
32-
}
29+
```json
30+
{
31+
"@context": "https://json-ld.org/contexts/person.jsonld",
32+
"@id": "http://dbpedia.org/resource/John_Lennon",
33+
"name": "John Lennon",
34+
"born": "1940-10-09",
35+
"spouse": "http://dbpedia.org/resource/Cynthia_Lennon"
36+
}
37+
```
3338

3439
The example above describes a person whose name is John Lennon. The difference
3540
between regular JSON and JSON-LD is that the JSON-LD object above uniquely
@@ -49,15 +54,15 @@ The Specifications
4954
If you are a developer, you may be interested in the official JSON-LD W3C
5055
specifications:
5156

52-
* `JSON-LD 1.1 - A JSON-based Serialization for Linked Data`_
53-
* `JSON-LD 1.1 Processing Algorithms and API`_
54-
* `JSON-LD 1.1 Framing`_
57+
* [JSON-LD 1.1 - A JSON-based Serialization for Linked Data][]
58+
* [JSON-LD 1.1 Processing Algorithms and API][]
59+
* [JSON-LD 1.1 Framing][]
5560

5661
A list of all previous specification drafts is also available.
5762

5863
https://json-ld.org/spec/
5964

60-
.. _list of users: https://github.com/json-ld/json-ld.org/wiki/Users-of-JSON-LD
61-
.. _JSON-LD 1.1 - A JSON-based Serialization for Linked Data: http://www.w3.org/TR/json-ld/
62-
.. _JSON-LD 1.1 Processing Algorithms and API: http://www.w3.org/TR/json-ld-api/
63-
.. _JSON-LD 1.1 Framing: http://www.w3.org/TR/json-ld-framing/
65+
[list of users]: https://github.com/json-ld/json-ld.org/wiki/Users-of-JSON-LD
66+
[JSON-LD 1.1 - A JSON-based Serialization for Linked Data]: http://www.w3.org/TR/json-ld/
67+
[JSON-LD 1.1 Processing Algorithms and API]: https://www.w3.org/TR/json-ld-api/
68+
[JSON-LD 1.1 Framing]: https://www.w3.org/TR/json-ld-framing/

0 commit comments

Comments
 (0)