This page explains how to write and edit wiki pages. The simplest way to create or modify a page is using GitHub’s online file editor. Each page has an “Edit page” link at the top right with a direct link to this interface.
Advanced users can make edits via a local installation of jekyll and a local clone of the site repository; see the advanced editing guide for setup instructions.
Creating a new page
Let’s dive in to how to create a new page on the site. If you are looking to edit an existing page, skip to adding and editing page content below.
Navigate to the pages section of the repository. Click then from the drop-down:
Add a name for your file. Note: this is not the page title; the page title will be applied in the next section, front matter. File names should be all lower case, use the file extension
.md, avoid symbols and spaces, and separate words using dashes (
Every page begins with a block of front matter: a sequence of parameters that configure your page. Without the front matter, your page will not render correctly. The following tables lists front matter fields you can use:
|title||The title of your page. This is the only required field.|
|description||A short description of your page. Also used for the site’s search engine. When omitted, the first sentence of the page content is used.|
|section||Main menu section that should be open when this page first loads, if any. Nested sections to expand should be separated by colons (
|categories||List of categories to which the page belongs. Must be enclosed in square brackets (
|statbox||The “Vital statistics” sidebar supports quite a few fields; see this comment for a list. Including at least one of these fields will cause the statbox to appear; otherwise, there will be no statbox for the page.|
Below is a minimal example front matter block. You can copy and paste this code
into the editor of a new page (see above). Replace
My Awesome Page with the
title for the new page.
--- title: My Awesome Page ---
Adding and editing page content
Pages on this site are optimized to be written in git markdown, but will also
html syntax. This section will cover how to populate the content of
your page, including: links to GitHub markdown resources, as well as guides on
how to use this site’s includes.
Markdown is plain-text syntax formatting, allowing you to easily and cleanly modify text with italics, bold, ordered or bulleted lists, etc. As a GitHub Pages hosted website, this wiki uses GitHub Flavored Markdown (GFM). A basic GFM guide can be found here.
Includes provide more robust formatting options and are unique to this site (think of this as: “I would like to include an image,” etc). With includes, you can insert menus, images, tables, sideboxes, figures, math, warnings, etc with pre-formatted settings into a page. For a full list of includes with utilization instructions, see below.
|bc||Insert menu breadcrumb|
|citation||Insert a citation|
|conference||Insert conference info|
|figure||Insert a figure|
|gallery||Insert an image gallery|
|github||Link to a resource on GitHub|
|image||Insert an image|
|notice||Insert a notice|
|person||Insert person details|
|sidebox||Insert a sidebox|
|symbol||Insert a symbol|
|table||Insert a table|
|wikipedia||Link to a Wikipedia page|
|youtube-video||Insert a video|