There are basically 3 steps:
- get a local copy of the sources;
- make you changes, render and check;
- once ready, submit to the maintainers.
Note: The minimal required tool sets for the recommended way are Git, a text editor, a Github account (free). However, only a text editor is strictly required. ,-)
- Get a local copy of the sources
- What to do next
- Create a blog post
- Create a documentation page
- Rendering my changes
- Submit to the maintainers
- About Jekyll
- Other ressources
Get a local copy of the sources
Cloning via the script in ‘offlineimap.git’
From OfflineIMAP’s Git repository (recommended)
This will clone the repository of the sources and do a bit of extra configuration.
Without OfflineIMAP’s Git repository
If you don’t have the offlineimap Git sources, you can download the script:
Note: If you downloaded the script via wget, you’ll have to configure the
username variable in the renderer file
Cloning with Git
From zip source
Login to Github, browse the sources online in your fork, pick up a file, edit and commit.
What to do next
Make your changes, check how it looks, and submit them to the maintainers, as for usual patches.
Create a blog post
Then, render it, check, push to your Github fork and make a pull request. If you don’t have a public Git repository, you can send the file of your post to the maintainers.
Create a documentation page
Contrary to the blog posts, pages in
_doc are not indexed automaticaly. Edit
documentation.html and add a new entry to your documentation page.
Be care that you have to set the URL as a target which ends with
.html. Not the source with the
Rendering my changes
There are two ways for rendering your changes before submitting them:
Via Github (recommended)
Using Github, via your public fork of the
For rendering it locally, you must have jekyll installed.
Submit to the maintainers
Push your changes to your public fork and request a pull.
Put the files you changed as a Gist and request the maintainers. Gists are usefull but not required, if you don’t like it use something else.
Requesting the maintainers the way you’d like:
- open an issue;
- send a mail.
Check out the Jekyll docs for more info on how to get the most out of Jekyll. Bug and feature requests for Jekyll are at Jekyll’s GitHub repo. If you have questions, you can ask them on Jekyll’s dedicated Help repository.
The source files use
.md extension for the kramdown syntax which is derivated from mardkown.
The look is very important. Feel free to add your own touch! We started from the base Jekyll theme because it’s clean and simple.
You can get inspiration from other’s customized themes.
Highlight is made by Jekyll with pygments.