Skip to content

Latest commit

 

History

History
95 lines (69 loc) · 4.8 KB

README.md

File metadata and controls

95 lines (69 loc) · 4.8 KB
Raw

spec-docs

University of Idaho Library Special Collections and Archives Documentation.

How To Use Template

Based on lesson-template. Overview:

  1. Work on the GitHub web interface or clone to your local machine to edit files (tip: click . on any GitHub repository to open the web editor).
  2. Edit the "_config.yml" file with your info (see Basic Configuration).
  3. Edit/add the content pages in Markdown found in the "content" folder (see Page Set Up).
  4. Add any images to the "images" folder.
  5. Commit on the web interface or push to GitHub from your local machine.

Creating Content

Content follows these conventions:

  • All documentation files are written in Markdown. For clearer version control, editing, accessibility, and reusability please:
    • write one sentence per line.
    • always provide a blank line between elements (i.e. headers, paragraphs, lists, code blocks are always followed by a blank line).
    • headers should follow logical order on page without skipping levels. The page template includes an "h1" using the title set in the front matter--thus additional headers on the page should start at "h2", i.e. ## in markdown.
    • code and variables should be given code class using backticks, filenames should be given in "quotes".
  • Markdown files are located in the "content" folder and can be further organized into folders inside if desired.

Create Navigation

The sidebar navigation menu is controlled by front matter added to each page. There are two ways a page can appear in the nav: individual or in a section drop down.

The nav follows these rules:

  • Individual listing: To list a page in the nav individually, add nav_order to the front matter of a content page. e.g. nav_order: 1. Do not include section_id or section in the front matter.
  • Section dropdown: To create a "section" drop down, on the first content page of the section, add nav_order and section_id to the front matter. The value of section_id will be displayed as the label for the section drop down. e.g. section_id: Workshop Prep. The page's title will be listed as the first item in the section dropdown.
  • Section pages: To add additional pages to the section dropdown, add section and nav_order to the front matter of a markdown file. The value of section must match a section_id set up on another markdown file. The page's title will appear under the corresponding section dropdown. The pages in the section will sort according to nav_order within the section--however, the page that sets up the section (with section_id) will always be listed first.

Note:

  • The nav listings (individual pages and sections) will be sorted by the value of nav_order.
  • If a markdown stub does not have nav_order or section in the front matter, the page will not appear anywhere in the navigation. Occasionally you might want to create pages that aren't linked in the nav, just be sure to link to them from somewhere else!
  • The values of section_id / section should be unique. If you create multiple sections with the same name, the nav won't work as expected!

Example Front Matter

Individual listing:

---
nav_order: 1
title: Introduction
---

Section lead:

---
section_id: Getting Started
nav_order: 3
title: Install Git and GitHub Desktop
---

Section content:

---
section: Getting Started
nav_order: 2
title: Configure Git
---

Template Assets

This repository does not include a Gemfile because it is a very simple project. It was originally built using Ruby 2.5+ and Jekyll 3.7+; most recently used Ruby 3 and Jekyll 4.3.2. It is designed to work with GitHub Pages automatic build versions.

The template makes use of a variety of open source libraries. These files are included in the 'assets/lib/" folder to ensure the project remains fully self contained. These assets include:

License

Learn-Static documentation and general web content is licensed Creative Commons Attribution-ShareAlike 4.0 International. Learn-Static code is licensed MIT. This license does not include external dependencies included in the "assets/lib" directory, which are covered by their individual licenses.