Primer Spec

Overview:

Primer Spec is a Jekyll theme designed to make long informative web pages, particularly project specifications, easier to read. It adds aesthetic styling and generates a table of contents displayed in a sidebar. The theme is built on top of the Primer theme and was primarily designed for hosting project specifications for EECS courses at the University of Michigan.

Features:

• Aesthetic Styling: Primer Spec enhances the appearance of long informative web pages.
• Table of Contents: The theme generates a sidebar table of contents for easy navigation.
• GitHub Pages Integration: Users can start using this theme with GitHub Pages right away.

Installation:

1. Add your Markdown/HTML files to the Jekyll site.
2. Insert the following code at the top of each “webpage” file to add the Primer Spec theme:

   ---
   layout: primer-spec
   ---
   

3. If it doesn’t already exist, create a file named _config.yml in your site’s root directory.
4. Add the following content to the _config.yml file:

   theme: jekyll-theme-primer-spec
   

5. Deploy your site with GitHub Pages.

Summary:

Primer Spec is a Jekyll theme that enhances the readability and navigation of long informative web pages, such as project specifications. It adds aesthetic styling and generates a sidebar table of contents. The theme is easy to install and can be used with GitHub Pages. It is primarily designed for hosting project specifications for EECS courses at the University of Michigan.