https://github.com/cgeo/cgeo.github.io

Repository for hosting the FAQ and homepage of c:geo. This is **NOT** the right place to report bugs against the app.
https://github.com/cgeo/cgeo.github.io

Last synced: about 1 month ago
JSON representation

Repository for hosting the FAQ and homepage of c:geo. This is **NOT** the right place to report bugs against the app.

• Host: GitHub
• URL: https://github.com/cgeo/cgeo.github.io
• Owner: cgeo
• Created: 2014-10-01T10:51:26.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-04-24T19:04:45.000Z (7 months ago)
• Last Synced: 2024-04-24T20:47:04.620Z (7 months ago)
• Language: HTML
• Homepage: http://cgeo.github.io/
• Size: 6.31 MB
• Stars: 18
• Watchers: 12
• Forks: 22
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Support: support.md

Awesome Lists containing this project

README

        
# c:geo website

This repository contains the [website of c:geo](http://www.cgeo.org/). If you are looking for the source code of the c:geo app, please visit [github.com/cgeo/cgeo](https://github.com/cgeo/cgeo) instead.

## How to install and run

This site uses Jekyll. In order to test it locally you need a working Ruby environment. See [this guide](https://www.ruby-lang.org/en/documentation/installation/) for how to install Ruby on your machine.

Once Ruby is working, install *bundler* for dependency management.

```

$ gem install bundler

```

Then you can `cd` into the clone of this repository and run `bundle install` to install all necessary dependencies.

Now you can compile the source and start a local webserver:

```

$ bundle exec jekyll serve

```

The site is available at `http://localhost:4000`.

As there might be changes in the dependencies and development in Jekyll you should run `bundle update` once in a while to update everything.

## Editing the FAQ

The FAQ is located in `_data/faq.yml`. As you can see this is a [YAML](http://www.yaml.org/) file. You do not need to understand the complete syntax, just keep the indentation as it is.

Each FAQ entry uses Markdown (with [kramdown](http://kramdown.gettalong.org/) extensions) for its content.

## Enable a warning

You can enable a warning by adding content to `_includes/warning.md` (Markdown syntax). It will be shown on the index page (currently only a single, red warning block).

To disable the warning again, insert `WARNING_DISABLED` somewhere in `_includes/warning.md`.