viptech / express-gateway.io

website for Express Gateway on express-gateway.io

express-gateway.io

This is the repository of the website express-gateway.io. It is hosted directly from the repository as a GitHub Pages website.

The main branch for this repository is dev.

The live site is published off gh-pages.

Please note: we use siteleaf.com as a CMS around this jekyll based site, changes that are committed to dev may be published automatically through content pushes through siteleaf.com to the gh-pages branch.

Local Setup

To run website locally:

1. Install Ruby and Bundler if you don't have them already.

Note: highly recommend installing rvm to install and manage Ruby

2. Install Jekyll and other important Gems. cd to the repository directory and run the command:

$ bundle install

3. Now do a build (this is only needed if pushing to GH pages)

$ bundle exec jekyll build

4. Run Jekyll using the following command:

$ bundle exec jekyll serve

5. You'll need to override _config.yml with the baseUrl set to "/"

6. Load http://localhost:4000/ on your browser.

Auto Regeneration

By default, Jekyll will auto-regenerate the static pages if you change files through a built in filewatcher. You can simply refresh your browser to see the updates.

Formatting

Jekyll uses a variant of Markdown known as Kramdown.

Jekyll uses the Liquid template engine for templating.

You can use GFM fenced code blocks.

Examples:

var express = require('express')
var app = express()
app.listen(3000)

apiEndpoints:
  help:
    host: '*.example.com'
    paths: /help

Algolia Index

Docsearch is crawling our website every day in order to generate our search index. When doing changes, especially to the HTML structure, remind to verify whether you're not breaking the used xpaths