You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Main site (playground): https://json-everything.net
4
-
- Docs: https://docs.json-everything.net
3
+
This repository houses the source for `json-everything` documentation site, https://docs.json-everything.net.
5
4
6
-
For editing tips, see https://chirpy.cotes.page/.
5
+
## Contributing
7
6
8
-
Please create any issues in the main repository, linked above.
7
+
We're happy to accept and review issues and PRs regarding the content of the documentation. As is the way of things, it can always be improved.
8
+
9
+
The API Reference docs are automatically generated by the [ApiDocsGenerator tool](https://github.com/json-everything/json-everything/tree/master/tools/ApiDocsGenerator) the main repository and synced here. Changes to the API Reference docs should be made there.
10
+
11
+
The main project's [CODE OF CONDUCT](https://github.com/json-everything/json-everything/blob/master/CODE_OF_CONDUCT.md) also applies.
12
+
13
+
## Running locally
14
+
15
+
The site is a standard [Jekyll-based GH Pages site](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll) using a modified [Chirpy theme](https://chirpy.cotes.page/).
16
+
17
+
You'll need to install the dependencies listed there to run it locally. Once all of the dependencies are available, you can run the `run.bat` or `run.sh` scripts to more easily start up the site.
18
+
19
+
Because of the API docs, the building the entire site will take a few seconds, so running the site with an incremental build is recommended.
20
+
21
+
## Style
22
+
23
+
Please see the [Chirpy theme site](https://chirpy.cotes.page/) for examples of the markdown that's supported.
0 commit comments