The Nocturne Theme

Nocturne is a simple dark purple Jekyll theme for GitHub Pages. You can preview the theme to see what is looks like, or even use it today.

Usage

To use the Nocturne theme:

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-nocturne"

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

theme: jekyll-theme-nocturne

Run bundle install

As a Remote Theme

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

remote_theme: GAchuzia/jekyll-theme-nocturne

Customizing

Configuration Variables

Nocturne will respect the following variables, if set in your site's _config.yml:

title: [The title of your site]
description: [A short description of your site's purpose]

Additionally, you may choose to set the following optional variables:

show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics: [Your Google Analytics tracking ID]

Stylesheet

If you'd like to add your own custom styles:

Create a file called /assets/css/style.scss in your site
Add the following content to the top of the file, exactly as shown:
```
---
---

@import "{{ site.theme }}";
```
Add any custom CSS (or Sass, including imports) you'd like immediately after the @import line

Note: If you'd like to change the theme's Sass variables, you must set new values before the @import line in your stylesheet.

Cutomizing Google Analytics Code

Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into _includes/head-custom-google-analytics.html in your Jekyll site

Overring GitHub-generated URLs

Templates often rely on URLs supplied by GitHub such as links to your repository or links to download your project. If you'd like to override one or more default URLs:

Look at the template source to determine the name of the variable. It will be in the form of {{ site.github.zip_url }}.
Specify the URL that you'd like the template to use in your site's _config.yml. For example, if the variable was site.github.url, you'd add the following:
```
github:
  zip_url: http://example.com/download.zip
  another_url: another value
```
When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub.

Note: You must remove the site. prefix, and each variable name (after the github.) should be indent with two space below github:.

For more information, see the Jekyll variables documentation.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Interested in contributing to Primer? We'd love your help. Primer is an open source project, built one contribution at a time by users like you. See the CONTRIBUTING file for instructions on how to contribute.

Previewing The Theme Locally

If you'd like to preview the theme locally (for example, in the process of proposing a change):

Clone down the theme's repository (git clone https://github.com/GAchuzia/jekyll-theme-nocturne.git)
Run bundle install
Run bundle exec jekyll serve
Open your browser to http://localhost:4000