| title | author | layout |
|---|---|---|
About the HSF newsletter website |
Torre Wenaus |
default |
This site is maintained by the HSF github repository people. If you're interested to become one contact the HSF startup team or any team member. It was set up by Torre Wenaus and Benedikt Hegner.
This website is implemented using github's Pages service which makes it easy to create a website associated with a github account or project. Pages uses Jekyll, a tool to automatically build a website from source files (which are kept in github). It supports structured sites like blogs in a simple but powerful way. We all like to work in code editors; this lets you write content in a friendly editor using the easy markdown syntax (which is used by github itself).
To create or edit files you have to use the github repository of the HSF website, so you need to be an HSF github repository user. Talk to any member of the startup team.
If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview submissions. See the documentation on installing and running Jekyll. The website uses user pages, ie use the master branch.
If you only do simple operations like the ones mentioned below, the GitHub interface itself gives you all options to add and edit such files in the browser.
Add a new file in workinggroups/_posts and follow the front-matter of the
other files in there. The list of news will be updated automatically.
Add a new file in workinggroups/_posts and follow the front-matter of the
other files in there. The navigation bar will be updated automatically.
Add a new file in events/_posts and follow the front-matter of the other files
in there. The events page will be updated automatically. Please don't forget
adding a startdate. Only this allows a proper ordering
Add a new file in jobs/_posts and follow the front-matter of the other files
in there. It is important to fill the field open: true. This field allows to
only show positions that aren't filled yet.
You can either use the github approach of forking a repository, do your changes there and make a pull request. Or if you want to store the draft into the main repository directly, you can put it into the _drafts/ folder. Adding --drafts to the command line of jekyll allows you to render them locally. Once happy, git mv it into the _posts/ directory and publish to the official repository.
As of writing, this website contains the following page templates:
- default - every page inherits from this
- event
- job_summary
- job
- newsletter
- page
- plain
The menu bar is defined in default.html, from which all page layouts inherit.
The layout is hard-coded except for the addition of working groups. A new post
in the workinggroups/_posts directory automatically adds the group to the drop
down menu Working Groups.
The side bar contains two dynamic blocks - upcoming events and current job
openings. Both are filled with liquid snippets defined in _includes.
- Jekyll to build websites from plain text
- The liquid template engine used by Jekyll
- markdown syntax