rzen/jekyll-theme-isabelline
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add link to readme blog from README.md

Browse Source
This commit is contained in:
rzen 2019-07-22 23:21:27 -04:00
parent 1fd08e472a
commit 1874a8fb62
2 changed files with 2 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -1,56 +1,3 @@
# jekyll-theme-isabelline # jekyll-theme-isabelline
Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`. README is being worked on in [a post](/README/)
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
TODO: Delete this and the text above, and describe your gem
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-theme-isabelline"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-theme-isabelline
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-theme-isabelline
## Usage
This theme supports pages, posts and blogs. Unlike posts, blogs can be setup to not show the date of the post in the article's URL.
Theme can be configured by tweaking `_sass/_config.scss`. To do so you need to first copy it from [github]() and place in `_sass/_config.scss`.
All colors are derived from `$hue`. You can tweak individual colors to your liking further down the config file.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/rzen/jekyll-theme-isabelline. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) 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-isabelline.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

1
_blog/README.md
View File

@ -2,6 +2,7 @@
title: README title: README
layout: post layout: post
date: 2019-07-22 date: 2019-07-22
permalink: /README/
tags: readme global wip tags: readme global wip
--- ---