For pagination to work, every new project has to be created as a "post". Therefore, every project should be created inside the _posts folder and respect the following guidelines:
- The file is written in markdown (.md)
- The name of the file is preceded by a date in the following format: year-month-day-. You can use the same date as another post. Although it has to be there, this date doesn't affect the rendering, so you could put 01-01-1959, it'd be fine.
- The name of the file will be used in the url, so keep it short and simple (and of course, no blank spaces, use - to separate words) Documentation to come
For example, a new project could be named: 02-07-2016-awesome-project.md
Once you've created a project, before writing its content, you have to specify elements in the YAML front matter. All that means is that you have to give each project its own variables. Layout, title and date are mandatory all the other ones are optional, but highly recommended. Note: that all the variables have to be placed inside two lines of ---
Check out this example:
---
- layout: post -------------------------------------------------- this is the same for every project
- title: "Awesome project with lots of tasks" ------------------- the project's name
- date: 2016-01-18 ---------------------------------------------- the actual day when the project was added
- img: "image-title.jpg" ---------------------------------------- Project's image.
- rep: "John Doe" ----------------------------------------------- Name of the rep for this project
- rep-img: "name.jpg" ------------------------------------------- Rep's image.
- rep-mail: "exemple@mail.com" ---------------------------------- Rep's email adress
- socialmatter1: "facebook" ------------------------------------- social media's name
- sociallink1: "link-to-social-page.com/"------------------------ http adress of the social media's page
- socialtext1: "Check out the facebook page of this project"----- text to be displayed on the social button
---
How to use these variables:
-
layout: should always be post
-
img: the project's image has to be placed in the "/img/projets" folder. If the variable doesn't exist or if nothing is specified, an image will be created, basically a rectangle filled with a specific color pattern and the name of the project in the middle.
-
rep-img: Has to be placed in the "/img/people" folder and should be 150x150 pixels. If the variable doesn't exist or if nothing is specified, an auto-fill will be used: placehold.it/150x150.
-
socialmatter#: will diplay social button(s) on the page. Simply use the official name of the social media. Ex: twitter, facebook, vimeo, youtube etc... For a website, the value should be set to "home". You can specify up to 6 social medias: socialmatter2, socialmatter3 and so on. The same goes for the sociallink(#) and socialtext(#) variables. IMPORTANT! no capital letters: instead of
Facebookuse facebook.
Inside the _hackathons folder, create a markdown file (.md), named after the event's title. This name will be used in the page's url.
ex: hackathon6.md
`---`
- **layout: post-hackathon** ---------------------------------------- this is the same for every event
- **title: "Hackathon 6"** ------------------------------------------ the event's name
- moment: "11 & 12 November 2016" ------------------------------- when the event is happening
- place: "Central Park, NY" ------------------------------------- where the event is taking place
- img: "hackathon6.jpg" ----------------------------------------- event's image.
- nextevent: "true" --------------------------------------------- write "true" to specify this event is "coming up"
- eventurl: "buy-tickets-here.com" ------------------------------ link to register for the event
- notes: "framapad.org" ----------------------------------------- link to notes/report (compte-rendu)
- objectif1: "Unite" -------------------------------------------- first objective of the event
- objectif2: "Work"---------------------------------------------- second objective
- objectif3: "Deploy"-------------------------------------------- third objective
---
How to use these variables:
- layout: should always be post-hackathon
- img: the event's image should be placed in the "/img/hackathons" folder
- nextevent: Can only be used ONCE within all events (will be displayed on homepage). If the variable doesn't exist or if nothing is specified, the homepage will display the most recent event.