softshake.github.com/README at master · gerauddelaval/softshake.github.com · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
Softshake's Website


h1. URLs : NO CONTENT OUTSIDE A YEAR

All HTML content has to be in a </YEAR/LG> directory.

For exemple, the association page for the 2013 edition has to be in the file `/2013/fr/association/index.html`.

This is to prevent several yearly editions.


h1. Technologies

h2. Github Pages

Workflow:

# Modify sources
# `git commit -m "Explanation of the modification"`
# `git push" (to put modifications on the server)
# See online the modification !

You can also use the Github app : http://mac.github.com/ (or http://windows.github.com/)


h2. Markdowm (Text Templating)

Github Pages supporting Markdown as default text templating engine to facilitate development.

It is HTML compliant :
* Or you can write full HTML code
* Or you can use Markdown synthax (http://daringfireball.net/projects/markdown/syntax)
* Or both.


h2. Jekyll

As Github Pages uses Jekyll (a blog engine), our website too :

* `_config.yml` (aka configuration file)

How run locally (to test for example) :

# Install Ruby on rails
# `gem install jekyll`
# `jekyll serve` (from the softshake root source directory)
# `localhost:4000` (from your favorite browser)