Skip to content

Commit b082b38

Browse files
committed
update readme for more public viewing and interaction
1 parent c3cb6df commit b082b38

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Greg Dennis
3+
Copyright (c) 2024 Greg Dennis
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
1-
Repo for blog content
1+
## Welcome
22

3-
- 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.
54

6-
For editing tips, see https://chirpy.cotes.page/.
5+
## Contributing
76

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

Comments
 (0)