bulmatown 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cf33656582634a453a7e2119a081162519d60f7f6e7d3869a2df20737d8ab8c
-  data.tar.gz: 25cd31c1d7eeb1147d4bec23a24b6fddf9988c1536cb4c98a44371a6bb6a010d
+  metadata.gz: f6b1bbf9cb02f2f439fe0cd0352ef94e1ce33f4cdd1b4ccff9263c3d73d8cd1e
+  data.tar.gz: 39e10115b969ef3f966c59f41598c2c4237fd502734d4565835a111dc066cddc
 SHA512:
-  metadata.gz: dd1a8720b2e838b6e67d2742e9e642bd6c3dffcd59288c07e8f4165f9aa67cb4da203d5a19643b15d8d98a6fbe3f5fbc481c002433f0d9f5ddbe380c54f530cd
-  data.tar.gz: 0ee7fac751358286b63c588bd14f82775b410d68003eb5b010593d217bf83724f815c5d55236101d652e4d5665f9429b4d6048969b19176591d62ec4c81e3827
+  metadata.gz: ad3829f03b11160c3d56d0ae38dd0de9fc88ca724c00453aad703225546a657795c68da6e9952646face44efe53bba97613c9358e93ab2f6052393d68829a396
+  data.tar.gz: ae053fe18c203ba28408dd7b15da402791a99cb049af10689cafdf4fb91500e2f24cc7b177eb6d461b73b3794dffe164d558568281bf93833da2b228af142306

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 # master
 
-* Use this file to keep track of plugin updates
+# 1.1.0 / 2021-02-01
 
-# 0.1.0 / 2020-05-01
+* Fix installation now that Liquid components use `.liquid` extension [#4](https://github.com/whitefusionhq/bulmatown/pull/4) ([arca0](https://github.com/arca0))
 
-* First version
+# 1.0.7 / 2020-10-19
+
+* Change layout files to .liquid extension for better compatibility with Bridgetown 0.18 template engine configurations
+
+# 1.0.6 / 2020-10-02
+
+* Remove red border from error syntax #3
+* Remove italics from syntax highlighting #2
+
+# 1.0.5 / 2020-06-27
+
+* Wide release

data/README.md

@@ -1,53 +1,117 @@
-# Sample plugin for Bridgetown
+# Bulmatown
+## A Bulma CSS starter theme for Bridgetown.
 
-_NOTE: This isn't a real plugin! Copy this sample code and use it to create your own Ruby gem! [Help guide here…](https://www.bridgetownrb.com/docs/plugins)_ 😃
+[Bulma](https://bulma.io) is a clean, modern CSS framework for rapid prototyping of content-focused websites. Use this theme to start using Bulma in your new [Bridgetown](https://www.bridgetownrb.com) site quickly, while preserving _all_ of the advanced customization possibilities as if you configured Bulma manually.
 
-A Bridgetown plugin to [fill in the blank]…
+**[LIVE DEMO](https://bulmatown.vercel.app)**
+
+![Bulmatown Example](https://res.cloudinary.com/mariposta/image/upload/c_thumb,w_900/v1593195961/bulmatown/bulmatown-example.jpg)
 
 ## Installation
 
-Run this command to add this plugin to your site's Gemfile:
+Bulmatown requires Bridgetown v0.15 or later
+
+To install Bulmatown while creating a new Bridgetown site:
+
+```sh
+bridgetown new mysite -a https://github.com/whitefusionhq/bulmatown
+```
+
+Or to add it to your existing Bridgetown site:
 
-```shell
-$ bundle add my-awesome-plugin -g bridgetown_plugins
+```sh
+bundle exec bridgetown apply https://github.com/whitefusionhq/bulmatown
 ```
 
+A few other (optional) plugins you might be interested in installing:
+
+* [SEO Tag](https://github.com/bridgetownrb/bridgetown-seo-tag)
+* [Atom Feed](https://github.com/bridgetownrb/bridgetown-feed)
+* Check out [Bridgetown community automations](https://github.com/bridgetownrb/automations) for some extra goodies like PurgeCSS, Swup page transitions, a test suite, and more!
+
 ## Usage
 
-The plugin will…
+The installation process will prompt you to configure your site to use Bulmatown automatically. However, if you decline those changes, you can inspect the [example site](https://github.com/whitefusionhq/bulmatown/tree/master/example) in this repository.
 
-### Optional configuration options
+Bulmatown comes with a few color variations out of the box. You can use the `theme_variation` Sass variable to switch the variation. For example:
 
-The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
+```scss
+// frontend/styles/index.scss
 
-…
+$theme_variation: rust;
 
-## Testing
+@import "~bulmatown/frontend/styles"
+```
 
-* Run `bundle exec rspec` to run the test suite
-* Or run `script/cibuild` to validate with Rubocop and test with rspec together.
+The available options are:
 
-## Contributing
+* `default`
+* `rust`
+* `fuchsia`
+* `fineart`
 
-1. Fork it (https://github.com/username/my-awesome-plugin/fork)
-2. Clone the fork using `git clone` to your local development machine.
-3. Create your feature branch (`git checkout -b my-new-feature`)
-4. Commit your changes (`git commit -am 'Add some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create a new Pull Request
+Speaking of Sass variables, you can put all your custom Bulma variables right before the `@import` statement and Bulma will pick up all the changes. You can even override any of the variables defined by Bulmatown out-of-the-box. [Read the Bulma documentation for more information.](https://bulma.io/documentation/)
 
-----
+### Hero Banners and Images
 
-## Releasing (you can delete this section in your own plugin repo)
+Bulmatown will automatically look for `image` front matter variables in your pages and documents and display those in the hero banners and in the card component for post previews. Check out the [bridgetown-cloudinary](https://github.com/bridgetownrb/bridgetown-cloudinary) plugin for an easy way to add advanced image asset handling to your site.
 
-To release a new version of the plugin, simply bump up the version number in both `version.rb` and
-`package.json`, and then run `script/release`. This will require you to have a registered account
-with both the [RubyGems.org](https://rubygems.org) and [NPM](https://www.npmjs.com) registries.
-You can optionally remove the `package.json` and `frontend` folder if you don't need to package frontend
-assets for Webpack.
+If you wish, you can alter which variable is loaded for the cards and social embeds vs. the hero banners using metadata:
+
+```yaml
+# src/_data/site_metadata.yml
+bulmatown_theme:
+  image_sizes:
+    embed: image
+    hero: image_hero
+```
 
-If you run into any problems or need further guidance, please check out our [Bridgetown community resources](https://www.bridgetownrb.com/docs/community)
-where friendly folks are standing by to help you build and release your plugin or theme.
+In addition, for a fun way to add some sparkle to a hero banner with an image background, you can put `rainbow_hero: true` in your front matter to display a nice colorful gradient.
+
+## Authors
+
+To show author information at the top of a blog post, add `authors.yml` to your data folder. For example:
+
+```yaml
+# src/_data/authors.yml
+jared:
+  name: Jared White
+  avatar: /images/jared-white-avatar.jpg
+  twitter: jaredcwhite
+  website: https://jaredwhite.com
+```
 
-**NOTE:** make sure you add the `bridgetown-plugin` [topic](https://github.com/topics/bridgetown-plugin) to your
-plugin's GitHub repo so the plugin or theme will show up on [Bridgetown's official Plugin Directory](https://www.bridgetownrb.com/plugins)! (There may be a day or so delay before you see it appear.)
+Then simply add `author: jared` to your post's front matter.
+
+This will link to an `/authors/<authorname>` URL. You can create a page at that URL manually, or you can auto-generate author archives using a Prototype Page. ([See this example file.](https://github.com/whitefusionhq/bulmatown/blob/master/example/src/authors/author.html))
+
+## Overriding Layout Templates and Components
+
+If you ever find yourself needing to override one or more of the layout templates or Liquid components provided by Bulmatown, you can use the `bridgetown plugins cd` command to drill down into the gem and copy files out to your own site. For example:
+
+```sh
+# copy the layouts folder:
+
+bundle exec bridgetown plugins cd Bulmatown/layouts
+
+cp -r bulmatown $BRIDGETOWN_SITE/src/_layouts
+exit
+
+# copy the components folder:
+
+bundle exec bridgetown plugins cd Bulmatown/components
+
+cp -r bulmatown $BRIDGETOWN_SITE/src/_components
+exit
+```
+
+Then you can go to the `bulmatown` folder in your layouts or components folders and make the changes from there. Or instead of wholesale copying over `bulmatown` entirely, you can pick and choose which files you want to copy.
+
+## Contributing
+
+1. Fork it (https://github.com/whitefusionhq/bulmatown/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/bridgetown.automation.rb

@@ -60,17 +60,28 @@ def add_template_repository_to_source_path
   end
 end
 
+def copy_if_exists(file)
+  target = File.exist?("src/_layouts/#{file}.html") ? "src/_layouts/#{file}.html" : "src/_layouts/#{file}.liquid"
+  copy_file "example/src/_layouts/#{file}.liquid", target
+end
+
+def substitute_in_default_if_exists
+  if File.exists?("src/_layouts/default.liquid")
+    gsub_file "src/_layouts/default.liquid", '{% render "footer", ', '{% render "footer", url: site.url, '
+  elsif File.exists?("src/_layouts/default.html")
+    gsub_file "src/_layouts/default.html", '{% render "footer", ', '{% render "footer", url: site.url, '
+  else
+    say_status :bulmatown, "Could not find the default template. You will have to add the url parameter to the render command manually"
+  end
+end
+
 if yes? "The Bulmatown installer can update styles, layouts, and page templates to use the new theme. You'll have the option to type 'a' to overwrite all existing files or 'd' to inspect each change. Would you like to proceed? (Y/N)"
   add_template_repository_to_source_path
 
   create_file "frontend/styles/index.scss", '@import "~bulmatown/frontend/styles"'
-  
-  copy_file "example/src/_layouts/home.html", "src/_layouts/home.html"
-  copy_file "example/src/_layouts/page.html", "src/_layouts/page.html"
-  copy_file "example/src/_layouts/post.html", "src/_layouts/post.html"
 
-
-  gsub_file "src/_layouts/default.html", '{% render "footer", ', '{% render "footer", url: site.url, '
+  ["home", "page", "post"].each { |f| copy_if_exists(f) }
+  substitute_in_default_if_exists
 
   copy_file "example/src/index.md", "src/index.md"
   copy_file "example/src/posts.md", "src/posts.md"
@@ -87,10 +98,11 @@ twitter = ask "Do you have a Twitter handle? If so, enter it here, otherwise typ
 if twitter != "" && twitter != "no"
   append_to_file "src/_data/site_metadata.yml" do
     <<~YAML
+
       twitter: #{twitter}
 
     YAML
   end
 end
 
-say_status :bulmatown, "Theme installation complete! Enjoy your fresh new design :)"
+say_status :bulmatown, "Theme installation complete! Enjoy your fresh new design :)"

data/bulmatown.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/whitefusionhq/bulmatown"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend|example)/!) }
   spec.test_files    = spec.files.grep(%r!^spec/!)
   spec.require_paths = ["lib"]
   spec.metadata      = { "yarn-add" => "bulmatown@#{Bulmatown::VERSION}" }

data/components/bulmatown/hero.scss

@@ -6,6 +6,7 @@ $gradient-bottom-right: transparentize(lighten(saturate(adjust-hue($dark, 10deg)
 .hero {
   background-size: cover;
   background-position: center center;
+  overflow: hidden;
   --overlay-center: #{$center};
   --overlay-top-left: #{$gradient-top-left};
   --overlay-bottom-right: #{$gradient-bottom-right};

data/components/bulmatown/navbar.scss

@@ -18,6 +18,10 @@
     }
   }
 
+  .navbar-brand {
+    font-weight: bold;
+  }
+
   .search-item input {
     font-size: 1em;
     height: 1.5em;

data/lib/bulmatown.rb

@@ -6,6 +6,5 @@ require "bulmatown/version"
 Bridgetown::PluginManager.new_source_manifest(
   origin: Bulmatown,
   components: File.expand_path("../components", __dir__),
-  content: File.expand_path("../content", __dir__),
   layouts: File.expand_path("../layouts", __dir__)
 )

data/lib/bulmatown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bulmatown
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bulmatown",
   "description": "A Bulma CSS starter theme for Bridgetown",
-  "version": "1.0.3",
+  "version": "1.0.7",
   "main": "frontend/javascript/index.js",
   "repository": {
     "type": "git",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulmatown
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Jared White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -139,45 +139,9 @@ files:
 - components/bulmatown/navbar.liquid
 - components/bulmatown/navbar.scss
 - components/bulmatown/pagination.liquid
-- content/bulmatown/example_page.md
-- content/bulmatown/train-on-rails.jpeg
-- example/.gitignore
-- example/Gemfile
-- example/bridgetown.config.yml
-- example/frontend/fonts/forkawesome-webfont.eot
-- example/frontend/fonts/forkawesome-webfont.svg
-- example/frontend/fonts/forkawesome-webfont.ttf
-- example/frontend/fonts/forkawesome-webfont.woff
-- example/frontend/fonts/forkawesome-webfont.woff2
-- example/frontend/javascript/index.js
-- example/frontend/styles/index.scss
-- example/package.json
-- example/plugins/builders/.keep
-- example/plugins/site_builder.rb
-- example/src/404.html
-- example/src/_components/footer.liquid
-- example/src/_components/head.liquid
-- example/src/_components/navbar.liquid
-- example/src/_data/authors.yml
-- example/src/_data/site_metadata.yml
-- example/src/_layouts/default.html
-- example/src/_layouts/home.html
-- example/src/_layouts/page.html
-- example/src/_layouts/post.html
-- example/src/_posts/2020-06-13-this-is-groovy.md
-- example/src/_posts/2020-06-13-welcome-to-bridgetown.md
-- example/src/about.md
-- example/src/favicon.ico
-- example/src/images/jared-white-avatar.jpg
-- example/src/index.md
-- example/src/posts.md
-- example/start.js
-- example/sync.js
-- example/webpack.config.js
-- example/yarn.lock
-- layouts/bulmatown/homepage.html
-- layouts/bulmatown/page.html
-- layouts/bulmatown/post.html
+- layouts/bulmatown/homepage.liquid
+- layouts/bulmatown/page.liquid
+- layouts/bulmatown/post.liquid
 - lib/bulmatown.rb
 - lib/bulmatown/version.rb
 - package.json
@@ -186,7 +150,7 @@ homepage: https://github.com/whitefusionhq/bulmatown
 licenses:
 - MIT
 metadata:
-  yarn-add: bulmatown@1.0.3
+  yarn-add: bulmatown@1.1.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -202,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Bulma CSS starter theme for Bridgetown

data/content/bulmatown/example_page.md

@@ -1,8 +0,0 @@
----
-layout: default
-title: Example Page
----
-
-If all goes well, this page will be accessible as [`{{ page.url }}`]({{ page.url }}), and you will see a photo of a train:
-
-![Train on Rails]({{ "/bulmatown/train-on-rails.jpeg" | relative_url }})

data/example/.gitignore

@@ -1,35 +0,0 @@
-# Bridgetown
-output
-.bridgetown-cache
-.bridgetown-metadata
-.bridgetown-webpack
-
-# Dependency folders
-node_modules
-bower_components
-vendor
-
-# Caches
-.sass-cache
-.npm
-.node_repl_history
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore Byebug command history file.
-.byebug_history
-
-# dotenv environment variables file
-.env
-
-# Mac files
-.DS_Store
-
-# Yarn
-yarn-error.log
-yarn-debug.log*
-.pnp/
-.pnp.js
-# Yarn Integrity file
-.yarn-integrity

data/example/Gemfile

@@ -1,22 +0,0 @@
-source "https://rubygems.org"
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-# Hello! This is where you manage which Bridgetown version is used to run.
-# When you want to use a different version, change it below, save the
-# file and run `bundle install`. Run Bridgetown with `bundle exec`, like so:
-#
-#   bundle exec bridgetown serve
-#
-# This will help ensure the proper Bridgetown version is running.
-#
-# To install a plugin, simply run bundle add and specify the group
-# "bridgetown_plugins". For example:
-#
-#   bundle add some-new-plugin -g bridgetown_plugins
-#
-# Happy Bridgetowning!
-
-gem "bridgetown"
-gem "bridgetown-quick-search", "~> 1.0", :group => :bridgetown_plugins
-
-gem "bulmatown", group: :bridgetown_plugins