Skip to content

A simple starter theme with an ITCSS Sass files organisation, a flexbox grid and modular typography

License

Notifications You must be signed in to change notification settings

joseph-norman/overkyll-jekyll-theme

 
 

Repository files navigation

Overkyll Jekyll Theme

Screenshot of Overkyll

Presentation

Fast and light, it can be use for a small blog or as a theme for starting a bigger site. Find the code of overkyll on Github

It implements this differents technologies :

  1. ITCSS architecture.
  2. Modular scale typography
  3. Unison JS Unifying named breakpoints across CSS, JS, and HTML
  4. LocalFont Implement localStorage web font caching in seconds
  5. LoadingCSS A function for loading CSS asynchronously
  6. Overpass An open source webfont family inspired by Highway Gothic
  7. Open Color Color optimized for UI like font, background, border, etc.
  8. Css lock Progressive increasing fontsize - in canal and river navigation

Install as Gem Theme

Jekyll requires Ruby so make sure Ruby is installed before you begin.

Start a New Site

  • Install Jekyll and Bundler
    • gem install jekyll bundler
  • Create a New Site
    • jekyl new mysite
  • Move into that directory
    • cd mysite
  • Verify
  • Download Overkyll Theme
    • Replace the line gem "minima" with this:
      • gem "overkyll-jekyll-theme"
    • Run bundle install
  • Tell Jekyll to use Overkyll Theme
    • Open _config.yml and change the line theme: minima to this:
      • theme: overkyll-jekyll-theme

Migrate an Existing Site

NOTE This requires you to be upgraded to at least Jekyll 3.3 which added support for themes and assets.

  • Download Overkyll Theme
    • Replace the line gem "minima" with this:
      • gem "overkyll-jekyll-theme"
    • Run bundle install
  • Tell Jekyll to use Overkyll Theme
    • Open _config.yml and change the line theme: minima to this:
      • theme: overkyll-jekyll-theme

Jekyll 2.x Method

Jekyll requires Ruby so make sure Ruby is installed before you begin.

  • Download this site
    • git clone https://github.com/bertrandkeller/overkyll-jekyll-theme.git
  • Move into its directory
    • cd overkyll-jekyll-theme
  • Install Required Gems
    • bundle install
  • Verify

About

A simple starter theme with an ITCSS Sass files organisation, a flexbox grid and modular typography

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 79.7%
  • HTML 15.8%
  • JavaScript 3.9%
  • Ruby 0.6%