Skip to content

Home

Jump to bottom
Will Pimblett edited this page Mar 29, 2016 · 11 revisions

The series of pages hosted here document the 2016 rebuild of the theatre website. The content and template of the site is stored here on GitHub in a Git repository. We use the Jekyll static site generator.

Editing

There are several options for editing site content.

  • Prose: Probably the simplest. All the technical bits of the repo are hidden away.
  • GitHub: This site, navigate to a page and click the pencil.
  • You can also edit pages on your local machine using a git client.

Pages and posts are written in Markdown. Markdown is "a lightweight and easy-to-use syntax for styling all forms of writing". See this GitHub guide for the basics, as we use the Kramdown variant see their docs for more advanced topics.

HTML can and is interspersed in our Markdown files.

Project structure

Content is stored in a number of directories in the project repo.

  • _content is for site pages
  • _posts is for blog posts

Page files are stored hierarchically, therefore to find the page for /get-involved/direct/ would be _content/get-involved/direct.md.

Page structure

Pages consist of front-matter and content. The front-matter is at the top surrounded by three dashes ---, the content follows. See the example below.

---
title: Get Involved
section: get-involved
---

Lorem ipsum dolor sit amet

The front-matter allows specifying meta-data for the page, such as the title, what section the page belongs e.t.c. Everything that comes after is the page content.

Staging and Master

When you make edits, make them to the staging branch. This will then be published at staging.alpha.newtheatre.org.uk. If all is well then create a [https://github.com/newtheatre/website/compare/master...staging](pull request) to merge your changes into the live site.

Clone this wiki locally