How to Contribute to this Site

The content of this site is editable by Hofstra students and faculty. Read this to learn how to add documents and make changes to the site.
Edit me

Cloning the repo

git clone https://git.cs.hofstra.edu/compsci/csc-docs.git
cd csc-docs

Taking your own branch

git checkout -b <your branch name here>

Where to save pages

Put all new documentation pages in

pages/mydoc

Frontmatter

Each page must have frontmatter at the top such as this:

---
title: Alerts
tags: [formatting]
keywords: notes, tips, cautions, warnings, admonitions
last_updated: March, 15, 2018
summary: "You can insert notes, tips, warnings, and important alerts in your content."
sidebar: mydoc_sidebar
permalink: mydoc_alerts.html
---

Frontmatter is always formatted with three hyphens at the top and bottom. Your frontmatter must have a title value. All the other values are optional. Please see this page for a comprehensive table of frontmatter variables supported on this site.

Markdown or HTML format

Pages can be either Markdown or HTML format (specified through either an .md or .html file extension).

If you use Markdown, you can also include HTML formatting where needed. But if your format is HTML, you must add a markdown="1" attribute to the element in order to use Markdown inside that HTML element:

<div markdown="1">This is a [link](http://exmaple.com).</div>

For your Markdown files, note that a space or two indent will set text off as code or blocks, so avoid spacing indents unless intentional.

If you have a lot of HTML, as long as the top and bottom tags of the HTML are flush left in a Markdown file, all the tags inside those bookend HTML tags will render as HTML, regardless of their indentation. (This can be especially useful for tables.)

Headings

Use pound signs before the heading title to designate the level. Note that kramdown requires headings to have one space before and after the heading. Without this space above and below, the heading won’t render into HTML.

## Second-level heading

Result:

Second-level heading


### Third-level heading

Result:

Third-level heading


#### Fourth-level heading

Result:

Fourth-level heading

Headings with ID Tags

If you want to use a specific ID tag with your heading, add it like this:

## Headings with ID Tags {#someIdTag}

Then you can reference it with a link like this on the same page:

[Some link](#someIdTag)

Result:

Some link

For details about linking to headings on different pages, see Automated links to headings on pages.

Specify a particular page layout

The configuration file sets the default layout for pages as the “page” layout.

You can create other layouts inside the layouts folder. If you create a new layout, you can specify that your page use your new layout by adding layout: mylayout.html in the page’s frontmatter. Whatever layout you specify in the frontmatter of a page will override the layout default set in the configuration file.

Jekyll Documentation Theme

This website is build on Tom Johnson’s Jekyll Documentation Theme. To learn about all the features it offers please see Supported Features. For details on how to author content, please see Pages and Posts.