Skip to content

niklasbuschmann/contrast

Repository files navigation

title permalink layout
About
/about/
page

Installation

Just fork this repository to your_username.github.io and adjust the _config.yml to use with Github Pages and your page is done.

Features

  • supports dark mode on macOS Mojave
  • optional sidebar
  • MathJax support
  • no external ressources
  • included archive page
  • supports pagination
  • feed generation
  • responsive
  • syntax highlighting
  • supports comments via disqus or isso

Installation

To run locally install Ruby and then run:

git clone https://github.com/niklasbuschmann/contrast.git
cd contrast
gem install bundler jekyll jekyll-feed
bundle exec jekyll serve

Config

Your _config.yml could for example look like this:

title: "Blog Title"
author: "Blog Author"
description: "My personal blog"
permalink: /:title/
lang: "en"
excerpt_separator: "\n\n\n"
date_format: "%B %d, %Y"

# Layout

show_excerpts: true             # show article excerpts instead of archive list on the home page
show_frame: true                # display a grey frame on large screens
show_sidebar: false             # show a sidebar instead of the usual header

# Menu                          # for available icons see https://fontawesome.com/v5/icons/

navigation:                     # accepts {file, title, url, icon, sidebaricon}
  - {file: "archive.html", sidebaricon: home}
  - {file: "README.md", sidebaricon: archive}

external:                       # accepts {file, title, url, icon, sidebaricon}
  - {title: Mail, icon: envelope, url: "mailto:[email protected]"}
  - {title: Github, icon: github, url: "https://github.com/niklasbuschmann/contrast"}
  - {title: Subscribe, icon: rss, url: "/feed.xml"}

footer: "Made with <b style='color: red'><3</b>"

comments:
#  disqus_shortname: ""         # see https://disqus.com
#  isso_domain: ""              # see https://isso-comments.de

plugins:
 - jekyll-feed

MathJax

Contrast comes preinstalled with a leightweight alternative to MathJax called KaTeX. To display equations in a post simply set mathjax: true in the article's front matter. Jektex can be used to pre-render math on the server side.

License

public domain

Screenshots

screenshot

screenshot

screenshot

About

Jekyll Theme

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages