Midnight is a Jekyll theme for GitHub Pages
Midnight is a Jekyll theme for GitHub Pages. You can preview the theme to see what it looks like, or even use it today.
To use the Midnight theme:
Add the following to your site's
_config.yml:
theme: jekyll-theme-midnight
Optionally, if you'd like to preview your site on your computer, add the following to your site's
Gemfile:
gem "github-pages", group: :jekyll_plugins
Midnight 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" to indicate whether to provide a download URL] google_analytics: [Your Google Analytics tracking ID]
If you'd like to add your own custom styles:
/assets/css/style.scssin 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
@importline
Note: If you'd like to change the theme's Sass variables, you must set new values before the
@importline in your stylesheet.
If you'd like to change the theme's HTML layout:
/_layouts/default.htmlin your site
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:
{{ site.github.zip_url }}.
_config.yml. For example, if the variable was
site.github.url, you'd add the following:
yml github: zip_url: http://example.com/download.zip another_url: another value
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.
See the open issues for a list of proposed features (and known issues).
The Midnight theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
Interested in contributing to Midnight? We'd love your help. Midnight 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.
If you'd like to preview the theme locally (for example, in the process of proposing a change):
git clone https://github.com/pages-themes/midnight)
cdinto the theme's directory
script/bootstrapto install the necessary dependencies
bundle exec jekyll serveto start the preview server
localhost:4000in your browser to preview the theme
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run
script/cibuild. You'll need to run
script/bootstrapone before the test script will work.