You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Crypto City 558eb4b66c add block post about PoS 4 months ago
_data add a couple faqs 8 months ago
_includes add discord link 4 years ago
_layouts add main page screenshots/text 4 years ago
_posts add block post about PoS 4 months ago
_sass add basic townforge config 4 years ago
assets make video as wide as the rest 4 years ago
images add new blog post 10 months ago
Gemfile add explorer/forum/wiki links to the top menu 4 years ago
LICENSE.txt initial import 4 years ago
MANUAL.html update manual 8 months ago
README.md initial import 4 years ago
_config.yml add discord link 4 years ago
about.md add third party tools page 3 years ago
download.md download: add 0.35.3.0 binaries 8 months ago
explorer.md add news page 3 years ago
faq.html add news page 3 years ago
git.md refer to gold as gold where appropriate 1 year ago
index.md Add a "what kind of game is it" FAQ 3 years ago
jekyll-theme-leaf.gemspec initial import 4 years ago
links.md add third party tools page 3 years ago
news.html add timestamp in news main page 3 years ago
paperwallet.md update paper wallet to latest and to default to townforge 5 months ago
pool.md add news page 3 years ago
robots.txt add robots.txt to avoid spamming the git server 4 years ago

README.md

jekyll-theme-leaf

👇👇

Preview Theme

Jekyll Theme Leaf is a very simple yet beautiful theme created by Supun Kavinda. It is designed for those who love dark sites.

Screenshot

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-leaf"

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

theme: jekyll-theme-leaf

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-leaf

Usage

Layouts

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

  • default.html - The base markup of all other layouts.
  • home.html - Home or index page layout.
  • page.html - Page layout (These are not listed as posts).
  • posts.html - Posts layout. These are listed in the home directory.

Includes

These are the files within the _includes directory.

  • footer.html - Markup for the footer. It's a minimal footer with the site title and twitter and github links.
  • google-analytics.html - Contains the Google Analytics code.
  • head.html - Contains the HTML code for the <head>.
  • header.html - The header/top navigation bar of the site.
  • hyvor-talk-comments.html - Hyvor Talk installation code with a customized color palette.

Sass

  • leaf.scss - The main SCSS file. Contains several variables and mixins.
  • _base.scss - Primary styles
  • _highlight-dark.scss - Code highlighting
  • _layout.scss - Layout SCSS files
    • _layout_header.scss - Styles of the header (_includes/header.html)
    • _layout_home.scss - Styles of the home (_layouts/home.html)
    • _layout-post.scss - Styles of the post and page layouts (_layouts/posts.html, _layouts/page.html)

Assets

  • assets/css/style.css - Imports _sass/leaf.scss.
  • assets/default-icon.png - The leaf icon.

Plugins

Leaf Jekyll theme uses two plugins by default.

  • jekyll-seo-tag - For better SEO
  • jekyll-feed - For RSS feed

Configuration

Here's the basic _config.yml file of this plugin.

title: Leaf Blog
iconURL: assets/default-icon.png
theme: jekyll-theme-leaf

permalink: :slug

social:
  twitter: YOUR_TWITTER
  github: YOUR_GITHUB

plugins:
 - jekyll-feed
 - jekyll-seo-tag

### comments & analytics
hyvor_talk_website_id: YOUR_WEBSITE_ID
google_analytics: UA-NNNNNNNN-N

Adding Comments

The Leaf Jekyll theme uses Hyvor Talk comments. The colors are customized based for the theme therefore you don't need to customize colors in the console.

  • First, login to the Hyvor Talk console
  • Register your website
  • Get your website ID from the General section of the console.
  • Then, replace YOUR_WEBSITE_ID in the above code in _config.yml with your code.

Ex:

hyvor_talk_website_id: 14

Adding Google Analytics

  • Sign up to Google Analytics
  • Add your website and get the tracking ID.
  • Replace UA-NNNNNNNN-N with your tracking ID.

Google Analytics will only appear in production.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/SupunKavinda/jekyll-theme-leaf. 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 leaf.gemspec accordingly.

License

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