Skip to content

Commit 4571fe0

Browse files
committed
Add a repo README
1 parent 0d0a02d commit 4571fe0

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

README.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
GSS website
2+
===========
3+
4+
This repository contains the [Jekyll](http://jekyllrb.com/) sources for the GSS website. Changes pushed to this repository will automatically appear on the website.
5+
6+
## Local development
7+
8+
Simply [install Jekyll](http://jekyllrb.com/docs/installation/) and run:
9+
10+
```shell
11+
$ jekyll serve --watch
12+
```
13+
14+
This will start website generation and serve the site at <http://localhost:4000>. Any file changes will cause a regeneration, and will be available on the site after a browser reload.
15+
16+
## Content management
17+
18+
Primary site contents are handled as [Jekyll posts](http://jekyllrb.com/docs/posts/) that can be either Markdown or HTML. The posts are stored in separate `_posts` folders under various folders of the site content categories:
19+
20+
* `home`: sections of the main page
21+
* `guide`: user guide articles
22+
* `example`: example articles
23+
24+
### Content ordering
25+
26+
As usual with Jekyll, the contents listings for each section will be ordered by post date, newest first. Set a correct date for each post (in the file name or metadata) to get the arranged in the way you like.
27+
28+
### Section IDs
29+
30+
To provide helpful styling hooks, the `section` tags on content listings will have IDs based on the URL of the post. So, for example the file `home/_posts/YYYY-MM-DD-hello-world.md` would generate the following section:
31+
32+
```html
33+
<section id="home_hello_world">
34+
<h1>Section title</h1>
35+
Section contents
36+
</section>
37+
```

_config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
title: GSS
22
permalink: /:categories/:title
3+
exclude:
4+
- "README.md"

0 commit comments

Comments
 (0)