public website for the practical scientific computing workshop
https://practical-scientific-computing.github.io/
Each page written in markdown requires some Front Matter for the Jekyll
processing engine. The front matter is contained in a block delimited by
---
.
---
title: Page title string
layout: default
group: Group Name
ordering: 1
type: index
---
The title
variable is the name of the page as it would appear in a browser
window. The title
is also used to populate navigation menu entries, so it is
required and best kept short in length.
The layout
variable is a standard Jekyll variable naming the template used
to render the page. See the Jekyll documentation for more information and other
built-in variables. The layout
is required to properly render a page.
The case-sensitive group
string is used to sort pages in the main navigation bar.
Only groups that are hard-coded in _include/bootstrap_navbar.html
are included
in the navigation.
The group
must be spelled as it would appear in a drop-down menu and all pages
in the group that are to be shown in the navigation require an appropriately
defined group
. Initially, there are four groups included in the navbar:
The ordering
variable is used to sort pages that appear in the navigation bar.
If ordering
is omitted (ie, null) then those pages appear at the bottom of the
menu and are sorted alpha-numerically by filename.
The type
variable sets the post format and can be one of the following:
All pages of type index are listed first in the dropdown navigation. They also will include the content of any same-group hero-type pages at full width above the content.
All pages of type tutorial will be listed in the site navigation drop-downs and under 'Core Tutorials' in the left sidebar for all pages in the same group.
All pages of type example will be listed in the left sidebar under the heading "Examples" on pages of the same group.
All pages of type advanced will be listed in the left sidebar under the heading "Advanced Topics" on pages of the same group.
The content-only of all pages of type hero will be inserted above the content of index pages in the same group. They are not intended to be true pages and serve only as a hack to include content on pages without using Jekyll include commands.
The content-only of all pages of type extra will be inserted in the right sidebar on all pages in the same group. They are not intended to be true pages and serve only as a hack to include content on pages without using Jekyll include commands.