https://github.com/rustpython/rustpython.github.io
https://github.com/rustpython/rustpython.github.io
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rustpython/rustpython.github.io
- Owner: RustPython
- License: mit
- Created: 2020-03-09T03:49:59.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-07-05T00:52:21.000Z (6 months ago)
- Last Synced: 2025-07-07T14:31:25.600Z (6 months ago)
- Language: HTML
- Homepage: https://rustpython.github.io
- Size: 77.7 MB
- Stars: 12
- Watchers: 6
- Forks: 19
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [rustpython.github.io](https://rustpython.github.io)
## Getting started
This site uses Jekyll. You can find instructions for how to install and configure Jekyll on [https://jekyllrb.com/docs/](https://jekyllrb.com/docs/).
You may also use a tool or service supporting [Development Containers](https://containers.dev/), such as Visual Studio Code or GitHub Codespaces. In that case, your development environment is already set up and includes Jekyll with the right version.
Run Jekyll with:
```bash
bundle exec jekyll serve --livereload
```
## How to Contribute
You can contribute by:
- writing an article,
- improving the theme (developers),
- improving the design of the site by sharing mockups or ideas (UX and designers).
## Writing
You can write a blog post in any language. There are no strict writing guidelines, but if you need ones, checkout [Digital Ocean Technical writing guides](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines).
As for what to write about, if you think it is worth sharing, then it is worth writing about (as long as it is about RustPython).
If you need inspiration:
- you can check out the issues marked with the label `content`,
- you can write a how-to, a technical article about something you learned while contributing to RustPython, a use case or just notes-to-future-self for how to configure something.
### Adding posts
The `_posts` folder is where the blog posts are.
To create a new post create a markdown file with this pattern: `YEAR-MONTH-DAY-title.md`, for example: `2020-10-01-why-rust-python-is-awesome.markdown`
Here is how the content of that file should look like.
```
---
layout: post
title: "Why RustPython is awesome!"
---
Content goes here.
```
Once you have your post ready, submit a pull request.
### Editing the homepage
To edit the homepage, you can modifty these files:
- `index.markdown`
- `_config.yml`
`config.yml` has settings like section titles and hyperlinks.
`index.markdown` has the text.
`contributors.json` is automatically generated and has a list of the top contributors.
## Improving the theme.
The theme doesn't rely on any css frameworks or javascript. It is just a super simple modification to the Jekyll `minima` theme.
### Color Scheme
The color scheme is that of the RustPython Logo:
 `#F74C00` or `rgb(247, 76, 0)`
 `#306998` or `rgb(48, 105, 152)`
 `#ffd43b` or `rgb(255, 212, 59)`