LLNL Theme for Jekyll Websites

Author: Ian Lee lee1001@llnl.gov and Elsa Gonsiorowski gonsie@llnl.gov

Installation

Add this line to you Jekyll site's Gemfile:

gem "jekyll-llnl-theme"

And add this line to your Jekyll site's _config.yml:

remote_theme: llnl/jekyll-llnl-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-llnl-theme

Usage

This theme supports multiple page websites. Any page which is located at /, such as /about.md, will be added to the navigation bar at the top. Each page should include the following YAML front matter:

---
layout: default
title: Title of the Page
---

Currently, there is only the default layout.

Adding a Blog

In true Jekyll fashion, a blog can be created by adding a _posts/ directory. See the Jekyll Documentation for details on formatting blog entries.

The following code is an example of how to create a list of blog entries:

<ul>
  {% for post in site.posts %}
    <li>
      <a href="{{ post.url }}">{{ post.title }}</a>
    </li>
  {% endfor %}
</ul>

Development

With Ruby Gems

Assuming working on OS X, tested on OS X 10.11.2. gem (Ruby package manager) was preinstalled, so just working from there:

# Install the dependencies:
    $ gem install jekyll

    # Build and serve the website
    $ jekyll serve --baseurl=''

    # Browse to (by default) `localhost:4000` in a web browser
    $ open localhost:4000

For more information, check out the full documentation at: jekyllrb.com/

With Bundler

Using Bundler:

# Install the dependencies
    $ bundle Install

    # Build and serve the website
    $ bundle exec jekyll serve --baseurl=''

    # Browse to (by default) `localhost:4000` in a web browser
    $ open localhost:4000

Contributing

Bug reports and pull requests are welcome on GitHub at github.com/llnl/jekyll-llnl-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the LLNL Contributing Guide code of conduct.

Release

This Jekyll theme is released under the MIT License. For more details see the LICENSE File.

LLNL-CODE-705597 LLNL-WEB-680594