This repository contains the sources of JSON Schema website:
- It's powered by Next.js,
- It uses Tailwind CSS framework,
- It's build and deployed with Netlify.
Use the following tools to set up the project:
Node.js v20.9.0+
This project uses git submodules, so you will need to run the following commands to fully clone the repo.
git submodule init
git submodule update
Install dependencies
yarn
Run the development server on http://localhost:3000
yarn dev
Build static files on /out folder
yarn build
This repository has the following structure:
โโโ .github # Definitions of GitHub workflows, pull request and issue templates
โโโ components # Various generic components such as "Button", "Figure", etc.
โโโ data # JSON Schema Implementations.
โโโ styles # Various CSS files
โโโ lib # Various JS code for preparing static data to render in pages
โโโ pages # Website's pages source. It includes raw markdown files and React page templates.
โ โโโ overview # JSON Schema initiative docs
โ โโโ blog # Blog posts
โ โโโ learn # JSON Schema docs
โ โโโ implementations # Various pages to describe tools
โโโ public # Data for site metadata and static blog such as images
โโโ next.config.js # Next.js configuration file
Here are some areas where you can contribute to the website:
- Blogs posts
- Case Studies
- Design
- Documentation
- Website enhancements
- Add a new JSON Schema Implementation
- JSON Schema Landscape
To figure out a good first issue to work on, join our Slack workspace and visit the #contribute channel. This channel is specifically designed for onboarding and supporting new contributors.
You should also check out our Contributing guidelines.
Thanks goes to these wonderful people who contributed to this website:
Made with contributors-img.
Become a financial contributor and help us sustain our community. [Contribute]
This document has been inspired by AsyncAPI website README.md.
The contents of this repository are licensed under either the BSD 3-clause license or the Academic Free License v3.0.