https://github.com/cgeo/whereyougo-website

Repository for hosting the FAQ and homepage of WhereYouGo. This is **NOT** the right place to report bugs against the app.
https://github.com/cgeo/whereyougo-website

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/cgeo/whereyougo-website
• Owner: cgeo
• Created: 2022-01-09T11:56:50.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-29T17:30:55.000Z (over 1 year ago)
• Last Synced: 2024-03-25T23:53:23.524Z (8 months ago)
• Language: SCSS
• Size: 48.8 KB
• Stars: 4
• Watchers: 14
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# WhereYouGo-website

This repository contains the [website of WhereYouGo](http://www.whereyougo.org/). If you are looking for the source code of the WhereYouGo app, please visit [github.com/cgeo/WhereYouGo](https://github.com/cgeo/WhereYouGo) 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`.