| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,28 @@ | |||
| 1 | + # README | ||
| 2 | + | ||
| 3 | + This is a Jekyll site + theme for [RustPython](https://github.com/RustPython/RustPython). | ||
| 4 | + | ||
| 5 | + There are three things on this site: | ||
| 6 | + - Homepage | ||
| 7 | + - Blog (archive + single post) | ||
| 8 | + - Links to Github/Gitter/Docs/other resources, etc... | ||
| 9 | + | ||
| 10 | + ## How to edit the homepage | ||
| 11 | + To edit the homepage, you can edit: | ||
| 12 | + - `index.markdown` in the root directory. | ||
| 13 | + - `_config.yml` also in the root directory. | ||
| 14 | + - `_data/contributors.json` | ||
| 15 | + | ||
| 16 | + `config.yml` has setting like section titles, where links go to etc... | ||
| 17 | + `index.markdown` has the longer text content. | ||
| 18 | + `contributors.json` has a list of the top contributors. I figured we can automate how this is generated or update through pull requests. | ||
| 19 | + | ||
| 20 | + ## How to edit the blog. | ||
| 21 | + Create regular jekyll posts under **_posts** . To feature a post on the homepage under _the learn more_ section, add the category "featured" to the post. | ||
| 22 | + | ||
| 23 | + ## How to edit links, menus and other details. | ||
| 24 | + | ||
| 25 | + Use `_config.yml`. | ||
| 26 | + | ||
| 27 | + ## The theme | ||
| 28 | + The theme doesn't rely on any css framework/ and no javascript. Just super simple modification to the minima theme. There are two stylesheets, `style.css` and `media.css`. I did not use `main.css` because it conflicts with minima's stylesheet. I haven't done a Jekyll theme in a while, so contributions are welcome. | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments