generated from cotes2020/chirpy-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update readme for more public viewing and interaction
- Loading branch information
1 parent
36d346f
commit 396158c
Showing
1 changed file
with
21 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,23 @@ | ||
Repo for blog content | ||
## Welcome | ||
|
||
- Main site (playground): https://json-everything.net | ||
- Blog: https://blog.json-everything.net | ||
This repository houses the source for `json-everything` blog site, https://blog.json-everything.net. | ||
|
||
For editing tips, see https://chirpy.cotes.page/. | ||
## Contributing | ||
|
||
We're happy to accept and review proposals for blog content. Ideally, posts will cover: | ||
|
||
- updates to the libraries or project in general | ||
- how the libraries are being used | ||
- interesting things learned while working on or with the libraries | ||
|
||
The main project's [CODE OF CONDUCT](https://github.com/json-everything/json-everything/blob/master/CODE_OF_CONDUCT.md) also applies. | ||
|
||
## Running locally | ||
|
||
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/). | ||
|
||
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. | ||
|
||
## Style | ||
|
||
Please see the [Chirpy theme site](https://chirpy.cotes.page/) for examples of the markdown that's supported. |