Skip to content

Commit 396158c

Browse files
committed
update readme for more public viewing and interaction
1 parent 36d346f commit 396158c

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

+21-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
1-
Repo for blog content
1+
## Welcome
22

3-
- Main site (playground): https://json-everything.net
4-
- Blog: https://blog.json-everything.net
3+
This repository houses the source for `json-everything` blog site, https://blog.json-everything.net.
54

6-
For editing tips, see https://chirpy.cotes.page/.
5+
## Contributing
6+
7+
We're happy to accept and review proposals for blog content. Ideally, posts will cover:
8+
9+
- updates to the libraries or project in general
10+
- how the libraries are being used
11+
- interesting things learned while working on or with the libraries
12+
13+
The main project's [CODE OF CONDUCT](https://github.com/json-everything/json-everything/blob/master/CODE_OF_CONDUCT.md) also applies.
14+
15+
## Running locally
16+
17+
The site is a standard [Jekyll-based GitHub 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/).
18+
19+
You'll need to install the dependencies listed in the GitHub docs 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.
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)