About Jekyll & Plaid

Jekyll & Plaid is a GitHub Pages theme for CMU projects. You write your docs in Markdown, and GitHub builds them into pages in CMU's web template, with the Carnegie Mellon Web Kilt's components.

How It Works

It's a Jekyll remote theme, so there's nothing to install: your repository names the theme in _config.yml, and GitHub Pages builds the site each time you push. Each page loads CMU's template from www.cmu.edu and the kit from jsDelivr.

• Markdown pages go in one column, with the CMU header, navigation, breadcrumbs and footer.
• Full-width pages use the sections layout and the template's own HTML: heroes, color bands, cards and sidebars.
• A small script turns code blocks into boxes with a copy icon, and GitHub's alerts into labeled callouts.

Each site uses the kit release the theme was tested with, unless it names another in _config.yml.

Set Up Your Site

Contributing to Jekyll & Plaid

The GitHub repository has the theme's code and documentation. To report a problem or suggest a change, open an issue or send a pull request.