jekyll-theme-classless-simple

jekyll-theme-classless-simple is a Jekyll theme styled with Simple.css, a classless CSS framework.

Installation

via remote_theme

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

remote_theme: toshimaru/jekyll-theme-classless-simple

via gem

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-classless-simple"

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

theme: jekyll-theme-classless-simple

And then execute:

$ bundle

Usage

# Specify theme
remote_theme: toshimaru/jekyll-theme-classless-simple
# Or,
# theme: jekyll-theme-classless-simple

classless-simple:
  syntax: monokai # syntax highlight theme

# Set to enable Google Analytics
google_analytics: UA-XXX 

# Navigation links in header
header_pages:
- home.md
- about.md
- categories.html

# Specify your language (default: en)
# lang: en

# Comment form powered by Giscus
# You can get the following values here: https://giscus.app/
giscus:
  repo: github-user-id/repo-name
  repo-id: R_xxx
  category-id: DIC_xxx
  # category: Announcements
  # lang: en
  # reactions-enabled: 1
  # emit-metadata: 0
  # input-position: bottom
  # theme: light

Layouts

Refers to files within the _layouts directory, that define the markup for your theme.

base.html: The base layout that lays the foundation for subsequent layouts.
home.html: The layout for your landing-page / home-page / index-page.
post.html: The layout for your posts.
page.html: The layout for your documents that contain FrontMatter, but are not posts.

Includes

footer.html: Defines the site's footer section.
head.html: Code-block that defines the <head></head> in default layout.
custom-head.html: Placeholder to allow users to add more metadata to <head />.
header.html: Defines the site's main header section.

Plugins

This theme depends on:

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/toshimaru/jekyll-theme-classless-simple. 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.

Your theme is setup just like a normal Jekyll 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, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in jekyll-theme-classless-simple.gemspec accordingly.

License

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