Skip to content

osmbe/website

Repository files navigation

OSM BE Website

The new OpenStreetMap Belgium website.

The master branch is published to https://openstreetmap.be.

Customizing the website

Feel free to customize the website content.

Creating an new post

  1. In the _posts directory, create a new Markdown file. Name the file in the pattern of YYYY-MM-DD-language-slug.md, where YYYY-MM-DD is the date of the event or post, language is the language of the post (fr, nl, en or ge) and slug is a short, unique identifier for post. For example, a post in English dated January 1, 2016 entitled "Mappy New Year" might be named 2016-01-01-en-mappy-new-year.md.

  2. At the top of the Markdown file, add front matter for your content type. Each post needs some extra information at the top of the file called front matter. The front matter determines what kind of content it is and other settings, like authorship or RSVP information. See the next section, Content types, for a listing of front matter options.

    Here's example front matter for a post:

    ---
    title: Missing Maps Mapathon at Doctors without Borders / Handicap International Brussels 
    featured: images/post/missing-maps.png
    layout: post
    author: Jorieke Vyncke
    lang: nl
    ---
    
  3. Beneath the front matter, write your post text. You can format your text using Markdown. For example:

    Artsen Zonder Grenzen (AZG) en Handicap International (HI) verwelkomen ons voor de volgende Missing Maps Mapathon. Kom en maak nieuwe kaarten met ons en samen met zij die de kaarten zullen gebruiken op het terrein! 
    
  4. Preview your work with the "preview" tab.

  5. Once you're satisfied with your new post, Propose a new file and then Create pull request. You pull request will be checked and merged to the website is everything is good.

In a few minutes, your post appears on website!

Content Types

Post

Posts are like blog posts. These are great for meetup follow-ups or posts that don't have a meetup event tied to it.

Name Required Value Description
layout Yes post This value should always be post.
lang Yes Language of the post This value must be fr, nl, en (or ge).
title Yes Title of your post
author No Author's name
featured No URL path to an image An image added here will show up for the post.

Getting help

  • If you're having a problem (or if you have a suggestion), create an issue and we'll respond to it.
  • The site is powered by Jekyll. To make custom tweaks to your own site, you should read Jekyll's documentation.
  • The website is running the site on GitHub Pages (i.e., on the gh-pages branch of your repository). See Getting Started with GitHub Pages for more information about using GitHub Pages.

This README file is based on Maptime README file.