2.6 KiB
jekyll-theme-yat
Hey, nice to meet you, you found this Jekyll theme. Here the yet another theme is a modern theme, and it's quiet clear, clean and neat for writers and posts.
Installation
Add this line to your Jekyll site's Gemfile:
gem "jekyll-theme-yat"
And add this line to your Jekyll site's _config.yml:
theme: jekyll-theme-yat
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-theme-yat
Usage
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
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 _data, _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-yat.gemspec accordingly.
Contributing
Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.
You can start by opening an issue describing the problem that you're looking to resolve and we'll go from there.
License
This theme is licensed under the MIT license © JeffreyTse.