Skip to content
A Jekyll theme for sites with content-heavy pages
CSS TypeScript HTML Shell JavaScript Ruby
Branch: develop
Clone or download
Pull request Compare This branch is 152 commits ahead, 4 commits behind pages-themes:master.

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.githooks
.github
_includes
_layouts
_sass
assets
demo
docs
script
src_js
.gitignore
.rubocop.yml
.travis.yml
Gemfile
LICENSE.md
README.md
VERSION
_config.yml
index.md
jekyll-theme-primer-spec.gemspec
jsconfig.json
package-lock.json
package.json
tsconfig.json
webpack.config.js

README.md

The Primer Spec theme

Build Status

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 live preview

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.

Contents

Usage

Primer Spec is a Jekyll theme, which means you can start using this theme with GitHub Pages right away!

  1. Add your Markdown/HTML files to the Jekyll site. These are your "webpages".

  2. Add Primer Spec to each "webpage" by inserting the following at the top of the file:

    ---
    layout: spec
    ---
  3. If it doesn't already exist, create a file _config.yml in your site's root directory. Add this content to the file:

    remote_theme: eecs485staff/primer-spec
    plugins:
        - jekyll-remote-theme
  4. 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.

User Showcase

The Primer Spec theme is currently used by the following courses at the University of Michigan:

Students: Would you like to see your course use this theme for their project specifications? Let your course staff know about this theme!

Course staff: If you have questions about how to integrate this theme with your project release workflow, create an issue, or email seshrs@umich.edu.

Contributing

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.

Acknowledgements

Primer Spec is maintained by Sesh Sadasivam (@seshrs) along with the EECS 485 Staff (@eecs485staff). Bella Kim (@bellakiminsun) contributed to the design, and designed the subthemes.

You can’t perform that action at this time.