zeus.ugent.be/README.md

101 lines
2.9 KiB
Markdown
Raw Normal View History

2016-06-09 15:04:10 +02:00
# zeus.ugent.be
2016-07-18 13:56:23 +02:00
[![Build Status](https://travis-ci.org/ZeusWPI/zeus.ugent.be.svg?branch=master)](https://travis-ci.org/ZeusWPI/zeus.ugent.be)
2017-05-20 16:20:57 +02:00
[![Code Climate](https://codeclimate.com/github/ZeusWPI/zeus.ugent.be.png)](https://codeclimate.com/github/ZeusWPI/zeus.ugent.be)
2017-06-03 12:33:32 +02:00
[![PageSpeed](https://pagespeed-badges.herokuapp.com/?url=zeus.ugent.be&strat=desktop&showStratLabel=true)](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fzeus.ugent.be&tab=desktop)
[![PageSpeed](https://pagespeed-badges.herokuapp.com/?url=zeus.ugent.be&strat=mobile&showStratLabel=true)](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fzeus.ugent.be&tab=mobile)
2016-06-09 15:04:10 +02:00
2016-08-23 20:21:02 +02:00
## Setup
### Installation
2016-06-09 15:04:10 +02:00
2016-06-10 12:22:59 +02:00
```bash
bundle install
2016-07-28 11:48:35 +02:00
npm install
2016-06-10 12:22:59 +02:00
```
2016-06-09 15:04:10 +02:00
2016-08-23 20:21:02 +02:00
### Developing
2016-06-09 15:04:10 +02:00
```bash
2016-08-21 18:03:53 +02:00
bundle exec nanoc live
2016-06-09 15:04:10 +02:00
```
2016-08-21 18:03:53 +02:00
This will spawn a webserver, and automatically recompile the site
when files get changed.
2016-06-09 20:20:22 +02:00
2016-08-23 20:21:02 +02:00
### Deploying
2016-06-09 20:20:22 +02:00
2016-07-19 13:43:32 +02:00
The latest builds on master get deployed automatically using [travis](https://travis-ci.org).
For manual deployment, run
2016-06-09 20:20:22 +02:00
```bash
bundle exec nanoc deploy --target public
```
2016-08-23 20:21:02 +02:00
2017-10-11 18:07:13 +02:00
## Events
Events can be fetched from facebook using `nanoc fetch [facebook event id]`. A file named `.fb_token` containing an app token for facebook must be present.
## Blogposts
2016-09-03 23:39:14 +02:00
Posts should be written in [kramdown](http://kramdown.gettalong.org/index.html), a markdown superset which has a very complete [syntax guide](http://kramdown.gettalong.org/syntax.html).
2016-12-06 10:27:57 +01:00
Meta-tags:
| Name | Type | Required |
|-------------|--------|----------|
| :title | String | yes |
| :created_at | Date | yes |
| :description| String | no |
| :author | String | no |
| :lang | String | no |
2016-08-23 20:21:02 +02:00
## Events
Example structure:
```
content/
assets/
events/
15-16/
16-17/
battlebots/
main.md
intro.md
codenight.md
finale.md
awk.md
sed.md
ruby.md
index.erb
```
### Metadata
Every event is a `.md` file with the following metadata tags:
2016-12-06 10:27:57 +01:00
| Name | Type | Required |
|--------------|--------|----------|
| :title | String | yes |
| :time | Date | yes |
| :location | String | yes |
| :description | String | no |
| :created_at | Date | no |
| :locationlink| String | no |
| :facebook | URL | no |
| :banner | URL | no |
| :image | URL | no |
2016-08-23 20:21:02 +02:00
### Grouped events
If there's a series of events (for example summer code nights) these can be grouped by creating a folder containing a `main.md`, which will need the following metadata:
2016-12-06 10:27:57 +01:00
| Name | Type | Required |
|--------------|--------|----------|
| :title | String | yes |
| :location | String | no |
| :banner | URL | no |
2016-08-23 20:21:02 +02:00
Other `.md` files made in that folder are sub-events which need to fit the [metadata description listed earlier](#metadata)