Skip to content

Commit

Permalink
Readme finnished
Browse files Browse the repository at this point in the history
  • Loading branch information
Dvogonen committed Jan 9, 2014
1 parent 5c53dbc commit 63ccc41
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# Maintaining the openTX Web
The OpenTX web is hosted on github. The site is built using Jekyll, which is the default page parsing and serving engine of Github.
Maintaining it is done primarily be editing html and markdown wiki pages.
The OpenTX web is hosted on github. The site is built using Jekyll, which is the default page parsing and serving engine of Github. Maintaining it is done primarily be editing html and markdown wiki pages.

## Fetch the site
In order to maintain the site, you need to clone the opentx.github.io repository.
Make the changes locally and commit and push them back when you are done.
It is a good idea to install Jekyll-Bootstrap on your local machine, so that you can test the changes.
In order to maintain the site, you need to clone the opentx.github.io repository. Make the changes locally and commit and push them back when you are done. It is a good idea to install Jekyll-Bootstrap on your local machine, so that you can test the changes.

## Site Structure
The site consists of pages in the root folder and posts in the _posts folder. The rest of the site is include files and will only need to be changed to alter the appearance and function, not to add content.
Expand All @@ -15,18 +12,19 @@ The normal way of adding content is to add new posts, rather than editing existi
## Adding a Post
* Select an old post in the _posts folder and make a copy of it.
* Change the file name. Please note that the date part MUST have the same format as used by the other posts. The text after the date string has no other meaning than to make the post easy to identify while editing.
* Edit the so yalled YAML part of the post. This is the first few lines which will look something like this:
* Edit the so yalled YAML part of the post. This is the first few lines which will look something like this.
```text
---
layout: post
title: "Modele Magazine article about Open9x (April 2013)"
description: ""
category: ""
tags: [Documents, French, News]
---
Change the title and tags fields. The title is displayed on the site as the name of the post. The tags are used to determine which pages that shows the post. Any number of tags can be used.
Current content tags are: Documents, Downloads, Releases, News
Current language tags are: Italian, French, Polish, Czech, German, English, Swedish

```
* Edit the title and tags fields. The title is displayed on all site pages as the name of the post.
The tags are used to determine which pages that shows the post. Any number of tags can be used.
Current content tags are: **Documents, Downloads, Releases, News**. Current language tags are: **Italian, French, Polish, Czech, German, English, Swedish**
* Edit the end of the post file to add some content.
* Test your changes and commit+push the new files to the remote repository.
* The publication is now done automatically by github!
Expand Down

0 comments on commit 63ccc41

Please sign in to comment.