Skip to content

wandnz/jekyll-theme-wand2

Repository files navigation

jekyll-theme-wand2

A theme made for the wand website.

Installation for local use

If theme folder is avaliable locally

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-wand2", path: "path/to/theme_folder"

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

theme: jekyll-theme-wand2

And then execute:

$ bundle install

If theme folder is stored on git

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-wand2", :git => 'https://github.com/wanduow/jekyll-theme-wand2', :branch => 'master'

And add this line to your Jekyll site's _config.yml and make sure to comment out any remote theme.

theme: jekyll-theme-wand2
#remote_theme: jekyll-theme-wand2

And then execute:

$ bundle install

Use on github pages

In your sites Gemfile comment out respective lines as shown in this example:

source "https://rubygems.org"
gem "jekyll" 
# gem "jekyll-theme-wand2 ", path: "../jekyll-theme-wand2"
group :jekyll_plugins do
  gem "github-pages"
  gem "jekyll-sitemap"
end

And in your sites _config.yml provide the following values, and comment out the line theme: jekyll-theme-wand2 if present.

title: WAND Group
email: 
description: >- # this means to ignore newlines until "baseurl:"
 Write an awesome description for your new site here. You can edit this
 line in _config.yml. It will appear in your document head meta (for
 Google search results) and in your feed.xml site description.
baseurl: "/wand.nz" # the subpath of your site, e.g. /blog
url: "https://wanduow.github.io" # the base hostname & protocol for your site, e.g. http://example.com
copyright: WAND Group
twitter_username: jekyllrb
github_username:  Jorsin
remote_theme: wanduow/jekyll-theme-wand2
#theme: jekyll-theme-wand2

Usage

Use a layout from theme refer to it in metadata under "layout tag"

---
layout: PREMADE-LAYOUT-NAME
---

Adding a link to nav bar, modify _data/navigation.yml with the format

- name:(eg People)
  link:(eg /people.html)

Creating a new collection (eg collect/_people)

Modify _config.yml with the format

collections:
     people:
        output: true
     research:
        output: true
     example-collection:
        output: true(determines if each listing will generate a unique page under its url)

Create the directory for your new collection inside your collections folder with an underscore at the front of its name. eg collection/_example-collection

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

License

The theme is available as open source under the terms of the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published