diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..bb94df8 --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +# frozen_string_literal: true + +source "https://rubygems.org" +gemspec diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..41e1c63 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,62 @@ +PATH + remote: . + specs: + tale (0.1.0) + jekyll (~> 3.6) + jekyll-paginate (~> 1.1) + +GEM + remote: https://rubygems.org/ + specs: + addressable (2.5.2) + public_suffix (>= 2.0.2, < 4.0) + colorator (1.1.0) + ffi (1.9.18) + forwardable-extended (2.6.0) + jekyll (3.6.0) + addressable (~> 2.4) + colorator (~> 1.0) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.14) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 3) + safe_yaml (~> 1.0) + jekyll-paginate (1.1.0) + jekyll-sass-converter (1.5.0) + sass (~> 3.4) + jekyll-watch (1.5.0) + listen (~> 3.0, < 3.1) + kramdown (1.15.0) + liquid (4.0.0) + listen (3.0.8) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + mercenary (0.3.6) + pathutil (0.16.0) + forwardable-extended (~> 2.6) + public_suffix (3.0.0) + rake (10.4.2) + rb-fsevent (0.10.2) + rb-inotify (0.9.10) + ffi (>= 0.5.0, < 2) + rouge (2.2.1) + safe_yaml (1.0.4) + sass (3.5.2) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + +PLATFORMS + ruby + +DEPENDENCIES + bundler (~> 1.12) + rake (~> 10.0) + tale! + +BUNDLED WITH + 1.14.6 diff --git a/LICENSE b/LICENSE index ac9e0d8..c7dc8ee 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2016 Chester How +Copyright (c) 2018 Chester How Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 1c87aad..34ed470 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,35 @@ Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here ![Tale screenshot](http://i.imgur.com/pXZrtmo.png) ## Features +- Easy installation - Compatible with GitHub Pages - Responsive design (looks just as good on mobile) - Syntax highlighting, with the help of Pygments - Markdown and HTML text formatting - Pagination of posts -## Usage -### 1. Fork and Clone -Fork this repository then clone it. +## Installation -### 2. Install dependencies -Tale uses Jekyll's built-SCSS compiler to generate CSS. You'll need to install the Jekyll gem: +1. Add this line to your `Gemfile`: -```bash -$ gem install jekyll +```ruby +gem "tale" ``` -### 3. Create your site -Edit the `_config.yml` file to suit your site. Also replace posts and content with your own. +2. And add this line to your `_config.yml`: -### 4. Running Locally -To test your site locally, run this in your site's root directory - -```bash -$ jekyll serve --watch +```yaml +theme: tale ``` +3. Install the theme's gems and dependencies: + + $ bundle + +4. Finally, build and serve your site + + $ bundle exec jekyll serve + Head to http://localhost:4000/tale/ to see your site in action. ## Contributing diff --git a/_config.yml b/_config.yml index f8395f6..f18b40c 100644 --- a/_config.yml +++ b/_config.yml @@ -8,9 +8,9 @@ baseurl: "/tale" url: "https://chesterhow.github.io" # Assets -sass: - sass_dir: _sass - style: :compressed +# sass: +# sass_dir: _sass +# style: :compressed # Build settings markdown: kramdown @@ -29,3 +29,5 @@ github: # Gems plugins: - jekyll-paginate + +theme: tale diff --git a/_includes/head.html b/_includes/head.html index bd096e8..33d7680 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -11,11 +11,11 @@ - + - - - + + + diff --git a/_sass/tale.scss b/_sass/tale.scss new file mode 100644 index 0000000..3cdfa99 --- /dev/null +++ b/_sass/tale.scss @@ -0,0 +1,8 @@ +@import 'tale/variables'; +@import 'tale/base'; +@import 'tale/code'; +@import 'tale/post'; +@import 'tale/syntax'; +@import 'tale/layout'; +@import 'tale/pagination'; +@import 'tale/catalogue'; diff --git a/_sass/_base.scss b/_sass/tale/_base.scss similarity index 100% rename from _sass/_base.scss rename to _sass/tale/_base.scss diff --git a/_sass/_catalogue.scss b/_sass/tale/_catalogue.scss similarity index 100% rename from _sass/_catalogue.scss rename to _sass/tale/_catalogue.scss diff --git a/_sass/_code.scss b/_sass/tale/_code.scss similarity index 100% rename from _sass/_code.scss rename to _sass/tale/_code.scss diff --git a/_sass/_layout.scss b/_sass/tale/_layout.scss similarity index 100% rename from _sass/_layout.scss rename to _sass/tale/_layout.scss diff --git a/_sass/_pagination.scss b/_sass/tale/_pagination.scss similarity index 100% rename from _sass/_pagination.scss rename to _sass/tale/_pagination.scss diff --git a/_sass/_post.scss b/_sass/tale/_post.scss similarity index 100% rename from _sass/_post.scss rename to _sass/tale/_post.scss diff --git a/_sass/_syntax.scss b/_sass/tale/_syntax.scss similarity index 100% rename from _sass/_syntax.scss rename to _sass/tale/_syntax.scss diff --git a/_sass/_variables.scss b/_sass/tale/_variables.scss similarity index 100% rename from _sass/_variables.scss rename to _sass/tale/_variables.scss diff --git a/assets/main.scss b/assets/main.scss new file mode 100644 index 0000000..6c114d8 --- /dev/null +++ b/assets/main.scss @@ -0,0 +1,5 @@ +--- +# Only the main Sass file needs front matter (the dashes are enough) +--- + +@import 'tale'; diff --git a/styles.scss b/styles.scss deleted file mode 100644 index 776bd2e..0000000 --- a/styles.scss +++ /dev/null @@ -1,13 +0,0 @@ ---- -# Use a comment to ensure Jekyll reads the file to be transformed into CSS later -# only main files contain this front matter, not partials. ---- - -@import 'variables'; -@import 'base'; -@import 'code'; -@import 'post'; -@import 'syntax'; -@import 'layout'; -@import 'pagination'; -@import 'catalogue'; diff --git a/tale.gemspec b/tale.gemspec new file mode 100644 index 0000000..80d3fdf --- /dev/null +++ b/tale.gemspec @@ -0,0 +1,20 @@ +# coding: utf-8 + +Gem::Specification.new do |spec| + spec.name = "tale" + spec.version = "0.1.0" + spec.authors = ["Chester How"] + spec.email = ["chesterhow@gmail.com"] + + spec.summary = %q{Tale is a minimal Jekyll theme curated for storytellers.} + spec.homepage = "https://github.com/chesterhow/tale" + spec.license = "MIT" + + spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(assets|_layouts|_includes|_sass|LICENSE|README)}i) } + + spec.add_runtime_dependency "jekyll", "~> 3.6" + spec.add_runtime_dependency "jekyll-paginate", "~> 1.1" + + spec.add_development_dependency "bundler", "~> 1.12" + spec.add_development_dependency "rake", "~> 10.0" +end