JSON-LD Official Website Documentation

The Development Playground is an experimental environment used specifically to test UI updates and new features of jsonld.js.

Warning: This environment is not intended for general use. It shares most files with the stable playground but operates using a non-revision-controlled version of jsonld.js, meaning it may contain unstable or experimental code.

JSON-LD Framing allows you to perform query by example and force a specific tree layout on a JSON-LD document.

Developers use Framing to restructure data retrieved from the Web to match the specific needs of their application. By restructuring the data before your application processes it, you can write simpler code for handling data from external sources.

JSON-LD is designed as a modular set of specifications. It is built upon two core base specifications, with all other features acting as layered extensions.

To use JSON-LD effectively, you should understand the relationship between these layers:

1. The JSON-LD Syntax: The foundation that defines the JSON-based format for serializing Linked Data.
2. The JSON-LD API: The programmatic layer providing algorithms for document transformations, such as applying or removing contexts.
3. Extensions: Higher-level specifications like Framing or the RDF API that build upon the Syntax and API to provide specialized functionality.

The website is built with Eleventy and deployed via Cloudflare Pages. To develop the site locally, use the following commands:

1. Install dependencies: npm i
2. Build static files to _site/: npm run build
3. Rebuild files on changes (watch mode): npm run watch
4. Serve the site with Cloudflare Pages feature support: npm run pages (available at http://localhost:8788/)

# install dependencies
npm i

# to just build the static files to `_site/`
npm run build

# to rebuild the files on changes
npm run watch

# to serve `_site/` with Cloudflare Pages feature support
npm run pages

To add a new unit test to the suite, follow these steps:

1. Assign a number: Pick the next available unit test number (e.g., 250).
2. Create the markup file: Create a .jsonld file in the tests/ directory using your chosen number (e.g., tests/rdf-250.jsonld).
3. Create the query file (for RDF tests): Create a .jsonld or .sparql file in the tests/ directory (e.g., tests/rdf-250.sparql).
4. Register the test: Add the new test entry to manifest.jsonld.

For practical perspectives and real-world application discussions, refer to blog posts such as:

• Building Meaningful Data APIs: Insights into using JSON-LD for API design.
• Webizing Databases: Using Linked Data in JSON-LD on Cloudant to expose database content as Linked Data.

You can generate PNG versions of the icons from the source SVGs using the provided Makefile. Use make to build the assets and make clean to remove old PNG files.

# To create the icons from SVG
$ make

# To clean up old pngs
$ make clean

To contribute a new test or a fix to an existing one:

1. Notify the community: Email the JSON-LD mailing list at public-linked-json@w3.org to announce your intention and the purpose of the change.
2. Clone the repository:

   git://github.com/json-ld/json-ld.org.git

3. Submit changes: Submit your changes via GitHub pull request or via git format-patch to the public-linked-json@w3.org mailing list.

To create a favicon.ico containing multiple sizes, follow these steps after running make to generate the PNGs:

1. Open the largest file (json-ld-data-64.png) in GIMP.
2. Go to File > Open as Layers...
3. Select the 32px and 16px files.
4. Export the result as favicon.ico.