Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 3.51 KB

README.md

File metadata and controls

62 lines (41 loc) · 3.51 KB
Raw

🚧 WIP 🚧 Swiss Jekyll Theme

Swiss is a bold Jekyll theme inspired by Swiss design and the works of Massimo Vignelli. This theme lends itself well to sites heavy on written content.

Features:

  • Mobile-first design ensures this theme performs fastest on mobile while scaling elegantly to desktop-size screens.
  • Designed for blogs and sites heavy on written content, with bold typography styles, homepage summaries, and previous/next snippets.
  • Supports a wide range of HTML elements and markdown.
  • Flexible styles that can be reused for customization without adding additional CSS.
  • Dynamically generated navigation links. See docs for adding pages with specific post category for-loops.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-swiss"

And add this line to your Jekyll site:

theme: jekyll-swiss

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-swiss

Usage

This theme comes in eight different color variations. The default is set to the black theme, to change to a different theme edit the config under theme-color: black to one of the following colors:
theme-color: black theme-color: red
black red
theme-color: white theme-color: gray
white gray
theme-color: blue theme-color: pink
blue pink
theme-color: orange theme-color: yellow
orange yellow

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/broccolini/swiss. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

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

You theme is setup just like a normal Jelyll 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.

When your theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

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