jekyll-theme-isabelline 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1ac9d1ab122327a347b63634460e9e27eca1f3a96b9048e575826daadf6785a
-  data.tar.gz: be20039cfafe23ae3726c61021e9bc155731bdf5b4b841521950ebf2da616882
+  metadata.gz: c86e7ba806cf1689be2fe65ccef7ce8011e118ffca5f50a02968c94e3548ee88
+  data.tar.gz: 855aa3f4f2e56526af0361db65d7c6053a837ab3b2e6fa570b18a103b86a14ec
 SHA512:
-  metadata.gz: fb2442d7e0c4af10f546598a9ee9b17d2f4ff9e506c44bd26ba302bb95f44ac594e1ea9bcaad303c8f61da7ea54080ec01716d6399f807833ce3640e894f9c40
-  data.tar.gz: fe71026b4f98f2bb9159f860c7b9f913de9b39856e60e66406b1f79edc035db09711b06a3dc0cfad9108688414c404fbaf0959ddb6d893a584a3ca2d92560d12
+  metadata.gz: 53d3da548f5ec902fc5655f527bbd5150681567a5c66a58b40f3812fe0d2e00768cca67a53fc4af8a66e0e5b1f01f997b4bcd69e4994ec07b19ef2582800a2c0
+  data.tar.gz: 1067bf70e9496673aac0d3ae6cd2c93b8ac5c9cdcc52094d7a83ce903aabc0dbae2815554157daf204aa90e20960978fc28d5e2fb07f55e1b66855125ca1a393

data/README.md

@@ -1,54 +1,78 @@
 # 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`.
+Simple clean mobile-friendly theme for long form blogging. Also good for private note taking.
 
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+## Installation
 
-TODO: Delete this and the text above, and describe your gem
+Fundamentally setting up a jekyll website with a theme is a straightforward process.
 
+1. Start with a website ([new](#how-to-create-new-jekyll-website) or existing).
 
-## Installation
+2. Update Gemfile to reference the new theme and plugins it requires
 
-Add this line to your Jekyll site's `Gemfile`:
+3. (Optionally) Backup previous configs.
 
-```ruby
-gem "jekyll-theme-isabelline"
-```
+4. Copy `isabelline`'s starter `_config.yaml` and customize it to your liking.
+
+5. Run bundle install.
+
+## Docker based cookbook
 
-And add this line to your Jekyll site's `_config.yml`:
+### How to create a new jekyll website
 
-```yaml
-theme: jekyll-theme-isabelline
+```sh
+ $ docker run --rm -it -v "$PWD:/srv/jekyll" jekyll/jekyll:3.8 jekyll new .
 ```
 
-And then execute:
+### How to backup previous configs
+
+`isabelline` needs the following files placed in the root directory of your jekyll website:
+
+`index.html`
+
+`_config.yaml`
+
+`Gemfile`
+
+`404.html`
 
-    $ bundle
+`private.html`
 
-Or install it yourself as:
+`docker-compose.yaml`
 
-    $ gem install jekyll-theme-isabelline
+These need to be copied manulaly.
 
-## 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.
+### Basic customization
 
-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`. 
+Simply follow instructions in `_config.yaml`.
+
+
+### Run jekyll locally using docker
+
+```sh
+ $ docker-compose up jekyll-serve
+```
+
+
+### Tweaking color scheme
+
+`isabelline` is a pretty color but she likes to play. Copy `_config.scss` from the source and place it under `_sass/_config.scss`. Follow instructions in that file on how to adjust colors.
 
-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`.
+To develop and test simply run from the root of a cloned `jekyll-theme-isabelline` project:
 
-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.
+```sh
+ $ docker-compose up jekyll-serve
+```
 
-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
 

data/_includes/footer.html

@@ -2,7 +2,7 @@
    <nav>
       <p>
          <span class="copy">&copy;</span> {{ 'now' | date: '%Y' }} {{ site.copyright_owner.full_name }}. 
-         <a href="/legal/">MIT License</a>. 
+         <a href="{{ site.license.url | default: '/legal/' }}">{{ site.license.name }}</a>. 
          <a class="edit" href="{{ site.edit_url | append: page.path }}">Edit</a>.
       </p>
    </nav>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-isabelline
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Rouslan Zenetl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-22 00:00:00.000000000 Z
+date: 2019-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll