Gem Gem

About

Theme blog for jekyll using Tailwindcss and Stimulus.js.

Preview

my blog use this theme https://rokhimin.github.io

Features

  • Stylish UI
  • Dark/Light Mode
  • Comment (Disqus)
  • Easy Changing Name Logo, About, Footer, etc
  • Page Projects (Editable)

Installation Jekyll

$ gem install jekyll

create first app

$ jekyll new yournameapp

Installation Theme

Installation theme Niri to your jekyll app

Add this line to your Jekyll site's Gemfile:

gem "tear-jekyll-theme"

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

theme: tear-jekyll-theme

And then execute:

$ bundle

Run jekyll:

$ bundle exec jekyll s

Setup

copy to _config.yml
title: Tear
email: [email protected]
description: >- 
  Write an awesome description for your new site here. You can edit this
  line in _config.yml. It will appear in your document head meta (for
  Google search results) and in your feed.xml site description.
baseurl: "" 
url: ""
logo: Tear
footer: "Created with ❤ by whdzera"
twitter_username: tear
github_username:  tear
linkedin_username:  tear
youtube_username:  tear
disqus: ""

plugins:
  - jekyll-feed

markdown: kramdown
kramdown:
  input: GFM
Create file 'projects.markdown' in '/' to use page Projects feature
copy to projects.markdown
---
layout: projects
permalink: /projects/
---
YOUR PROJECT
edit about.markdown
---
layout: about
permalink: /projects/
---
YOUR ABOUT

Developer

Run Jekyll

rake run

Run Tailwindcss mode --watch

rake css

Run Unit test

rake test

Contributing

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

License

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