Skip to content

isomerpages/govtech-hcp

Repository files navigation

Welcome to Isomer Pages!

Why Markdown and YAML?

Traditionally, in order to edit a website, one had to write in pure HTML. This is challenging for website administrators who had limited experience with HTML as it is not immediately readable or intuitive to non-experienced users.

Our team decided to go with Markdown (.md) – more human readable syntax – so as to empower non-technical website administrators.

While Markdown is appropriate for writing long segments of text, it alone does not allow users to edit small details of the website (e.g. change the hero-banner image) without diving into the HTML.

We therefore chose to supplement the Markdown syntax with YAML (.yml) – yet another human readable syntax.

How to run locally

Looks like it's using jekyll under the hood

  1. install ruby
  2. install jekyll (gem install jekyll bundler)
  3. run the server (bundle exec jekyll serve)