LLNL/Jekyll-LLNL-Theme

Name: Jekyll-LLNL-Theme

Owner: Lawrence Livermore National Laboratory

Description: LLNL Themed Jekyll Template

Created: 2016-02-24 08:07:34.0

Updated: 2017-12-06 05:27:22.0

Pushed: 2017-12-14 00:56:50.0

Homepage: https://software.llnl.gov/Jekyll-LLNL-Theme

Size: 4247

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

LLNL Theme for Jekyll Websites

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

Installation

This gem can be used in two ways: either as a gem-based theme or through GitHub pages remote theme support (details here).

Gem-Base Theme

Add this line to your Jekyll site's Gemfile:

"jekyll-llnl-theme"

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

e: jekyll-llnl-theme

And then execute:

ndle

Or install it yourself as:

m install jekyll-llnl-theme

GitHub Pages Remote Theme

This is a recent addition to GitHub pages and is simple to use. Add this line to your site's Gemfile:

"github-pages", group :jekyll_plugins

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

te_theme: LLNL/Jekyll-LLNL-Theme

It is unclear if the remote theme is suitable for local development, but it will work on deployed sites.

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:

ut: default
e: 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:

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

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:

stall the dependencies:
m install jekyll

ild and serve the website
kyll serve --baseurl=''

owse to (by default) `localhost:4000` in a web browser
en localhost:4000

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

With Bundler

Using Bundler:

stall the dependencies
ndle Install

ild and serve the website
ndle exec jekyll serve --baseurl=''

owse to (by default) `localhost:4000` in a web browser
en localhost:4000

Contributing

Bug reports and pull requests are welcome on GitHub at https://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