The Primer Spec theme
Primer Spec is a Jekyll theme that makes long informative web pages easier to read. In addition to aesthetic styling, the theme generates a table of contents displayed in a sidebar. You can preview the theme to see what it looks like, or even use it today.
Primer Spec is built on top of the wonderful Primer theme, and adds functionality useful for pages with a lot of content. This theme was primarily designed for hosting project specifications for EECS courses at the University of Michigan. See the User Showcase for inspiration.
Primer Spec is a Jekyll theme, which means you can start using this theme with GitHub Pages right away!
Add your Markdown/HTML files to the Jekyll site. These are your "webpages".
Add Primer Spec to each "webpage" by inserting the following at the top of the file:
--- layout: spec ---
If it doesn't already exist, create a file
_config.ymlin your site's root directory. Add this content to the file:
remote_theme: eecs485staff/primer-spec plugins: - jekyll-remote-theme
Deploy your site with GitHub pages!
This repository hosts a Primer Spec site too! The original Markdown content is in index.md, and you can preview the page at https://eecs485staff.github.io/primer-spec/index.html.
If you aren't using GitHub Pages, or if you'd like to preview your webpages locally, refer to the Advanced Usage docs.
The Primer Spec theme is currently used by the following courses at the University of Michigan:
- EECS 280 (Programming and Intro Data Structures). Example EECS 280 Project 4: Web.
- EECS 285 (Practical Programming in Java). Example EECS 285 Project 3: Wheel of Fortune.
- EECS 485 (Web Systems). Example EECS 485 Project 4: Map Reduce.
Students: Would you like to see your course use this theme for their project specifications? Let your course staff know about this theme!
Interested in contributing to Primer Spec? We'd love your help. Primer Spec is an open source project, built one contribution at a time by users like you. See the CONTRIBUTING file for further instructions on how to contribute.
For maintenance and release instructions, see Maintenance & Release section of the CONTRIBUTING file.