Skip to content

Structure and Orientation

Torbjörn Klatt edited this page Jan 18, 2016 · 6 revisions

There is a specific structure to the sources of the website you need to understand before you can edit and add your own content. Most of the time, it should be fairly straight forward to wrap your head around it.

Structure

The site is ordered into a few general topics: News, Events, Projects and Software.

Each of these topics has an own directory where to put new content and certain templates:

Topic Directory Template
Events _events_past event_past_page [[Help
_events_upcoming event_upcoming_page
News _posts news_post [[Help
Projects _projects project_page [[Help
Software _software software_page [[Help

Read about the short and few details on Adding/Modifying Content.

Conventions

Jekyll and its plugins we are using expect certain conventions with respect to filenames, file content and file formats.

This is just an overview of the most significant points. More details can be found here.

News Posts

The file name must start with a date of the form YYYY-MM-DD followed by the title in lowercase and simple dashes as word separation. The following are valid file names:

2013-02-21-awesome-news.md
2014-05-26-3rd-workshop.md

And these are invalid file names:

07-2-1_tried-but failed.md
2014-05-26_3rd-workshop.md

Please, use the date of creation for news posts.

Events (past and upcomming)

Same rules apply as with news posts with the exception to use the event's start date as the date for its file name.

Structure of Content Files

All content files (those, which are of type text/plain and have the .md ending) have a YAML-formatted header enclosed in two lines of three dashes.

This header provides all the basic meta information for the specific content, such as Title, Author, Creation Date, Date of Last Update, Rendering Template, etc.

The actual Markdown-formatted content follows after the header.

Clone this wiki locally