|
1 | | -#README |
| 1 | +#rustpython.github.io |
2 | 2 |
|
3 | | -This is a Jekyll site + theme for[RustPython](https://github.com/RustPython/RustPython). |
| 3 | +##Getting started |
4 | 4 |
|
5 | | -There are three things on this site: |
| 5 | +This site uses Jekyll. You can find instructions for how to install and configure Jekyll on[https://jekyllrb.com/docs/](https://jekyllrb.com/docs/). |
6 | 6 |
|
7 | | -- Homepage |
8 | | -- Blog (archive + single post) |
9 | | -- Links to Github/Gitter/Docs/other resources, etc... |
| 7 | +##How to Contribute |
| 8 | +You can contribute by: |
| 9 | +- writing an article, |
| 10 | +- improving the theme (developers), |
| 11 | +- improving the design of the site by sharing mockups or ideas (UX and designers). |
10 | 12 |
|
11 | | -##How to edit the homepage |
| 13 | +##Writing |
12 | 14 |
|
13 | | -To edit the homepage,youcan edit: |
| 15 | +You can write a blog post in any language. There are no strict writing guidelines, but ifyouneed ones, checkout[Digital Ocean Technical writing guides](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines). |
14 | 16 |
|
15 | | --`index.markdown` in the root directory. |
16 | | --`_config.yml` also in the root directory. |
17 | | --`_data/contributors.json` or run`update_contributors.py` |
| 17 | +As for what to write about, if you think it is worth sharing, then it is worth writing a blog post about (as long as it is about RustPython). |
18 | 18 |
|
19 | | -`config.yml` has setting like section titles, where links go to etc... |
20 | | -`index.markdown` has the longer text content. |
21 | | -`contributors.json` has a list of the top contributors. I figured we can automate how this is generated or update through pull requests. |
| 19 | +If you need inspiration, you can check out the issues marked with the label`content`, you can also write a how-to, a technical article about something you learned while contributing to RustPython, a use case or just notes to self for how to configure something. |
22 | 20 |
|
23 | | -##How to edit the blog. |
| 21 | +###Adding posts |
24 | 22 |
|
25 | | -Create regular jekyll posts under**\_posts**. Tofeature a poston the homepage under_the learn more_ section, add the category "featured" to the post. |
| 23 | +The`_posts` folder is where the blog posts are. Tocreate anewpostcreate a markdown file iwth this pattern:`YEAR-MONTH-DAY-title.md`, for example:`2020-10-01-why-rust-python-is-awesome.markdown` |
26 | 24 |
|
27 | | -##How to edit links, menus and other details. |
| 25 | +Here is how the content of that file should look like. |
28 | 26 |
|
29 | | -Use`_config.yml`. |
| 27 | +``` |
| 28 | +--- |
| 29 | +layout: post |
| 30 | +title: "Why RustPython is awesome!" |
| 31 | +--- |
30 | 32 |
|
31 | | -##The theme |
| 33 | +Content goes here. |
32 | 34 |
|
33 | | -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. |
| 35 | +``` |
| 36 | + |
| 37 | +Once you have your post ready, submit a pull request. |
| 38 | + |
| 39 | +###Editing the homepage |
| 40 | + |
| 41 | +To edit the homepage, you can modifty these files: |
| 42 | + |
| 43 | +-`index.markdown` |
| 44 | +-`_config.yml` |
| 45 | + |
| 46 | +`config.yml` has setting like section titles and hyperlinks. |
| 47 | + |
| 48 | +`index.markdown` has the text. |
| 49 | + |
| 50 | +`contributors.json` is automatically generated and has a list of the top contributors. |
| 51 | + |
| 52 | +##Improving the theme. |
| 53 | + |
| 54 | +The theme doesn't rely on any css frameworks or javascript. It is just a super simple modification to the Jekyll`minima` theme. |
| 55 | + |
| 56 | +###Color Scheme |
| 57 | + |
| 58 | +The color scheme is that of the RustPython Logo: |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +`#F74C00` or`rgb(247, 76, 0)` |
| 63 | + |
| 64 | +`#306998` or`rgb(48, 105, 152)` |
| 65 | + |
| 66 | +`#ffd43b` or`rgb(255, 212, 59)` |