Skip to content

openmind-consortium/openmind-consortium.github.io

Repository files navigation

OpenMind Consortium Website

Travis License

Overview

OpenMind Consortium Hugo website.

Getting Started

Prerequisites

Local development

Start the server

hugo serve -D

go to localhost:1313

Build site locally

This will build the site in the public/ directory.

hugo

Deployment

The site is deployed to GitHub Pages using Travis. Changes to the site should be done in the Hugo project (hugo-site branch). Never commit to master, that branch will be updated by Travis whenever a new build is done.

Updating Content

The code is on GitHub. We will use the gitflow branching model. Currently, there are two ways to update content:

  1. GitHub: If you want to add or update content, create a feature branch from hugo-site. When done submit a PR to hugo-site.

**Any change pushed to hugo-site will trigger a Travis build. If the build is successful, the site will be deployed to Github Pages.

  1. Forestry.io: A static CMS that commits. Forestry gives you a GUI to update content. It's also convenient for small changes. When changes are saved, Forestry will commit and push to hugo-site. That will trigger the deployment process.

Updating Site configuration and parameters

The main parameters that define basic sections of the website (title, footer, menus, etc.) are set in the config.yaml file.

Creating New Content

From the command line, with Hugo installed:

hugo new content/post/new_content.md

Each file in the content/post folder corresponds to a block row in the website. Just add content in Markdown format.

Content can also be added or updated using Forestry.io