bulmatown 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cf33656582634a453a7e2119a081162519d60f7f6e7d3869a2df20737d8ab8c
-  data.tar.gz: 25cd31c1d7eeb1147d4bec23a24b6fddf9988c1536cb4c98a44371a6bb6a010d
+  metadata.gz: bde2c36a6b0aa5db52f126be19ebaf319a2763b01e2c346d97c6863923c4118c
+  data.tar.gz: 7379168a870496af8bcfd16f4964d9425aa1bb920051fb3f654f5451f3267616
 SHA512:
-  metadata.gz: dd1a8720b2e838b6e67d2742e9e642bd6c3dffcd59288c07e8f4165f9aa67cb4da203d5a19643b15d8d98a6fbe3f5fbc481c002433f0d9f5ddbe380c54f530cd
-  data.tar.gz: 0ee7fac751358286b63c588bd14f82775b410d68003eb5b010593d217bf83724f815c5d55236101d652e4d5665f9429b4d6048969b19176591d62ec4c81e3827
+  metadata.gz: 1e2002b3a0715b06aea00916b18237daadb7f1c71cf14e6030a11b01fa03a48109a89162574042af480f7fe30314016ea2d3405e9a204a6cf1aec3fffdb18c57
+  data.tar.gz: 55a5a8466323dee2c1d9607cc3836c5bfb37c317700b850112e8c8aa0f14e8f62cac3d31e6b39ec3bf1a50438e1df0d04bb16fd2064ee0f41a88501bf80e1dd5

data/README.md

@@ -1,53 +1,78 @@
-# 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 customizations 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
 ```
 
 ## 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.
+
+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:
 
-### Optional configuration options
+```scss
+// frontend/styles/index.scss
 
-The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
+$theme_variation: rust;
 
-…
+@import "~bulmatown/frontend/styles"
+```
 
-## Testing
+The available options are:
 
-* Run `bundle exec rspec` to run the test suite
-* Or run `script/cibuild` to validate with Rubocop and test with rspec together.
+* `default`
+* `rust`
+* `fuchsia`
+* `fineart`
 
-## Contributing
+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/)
 
-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
+## 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:
 
-## Releasing (you can delete this section in your own plugin repo)
+```sh
+# copy the layouts folder:
 
-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.
+bundle exec bridgetown plugins cd Bulmatown/layouts
 
-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.
+cp -r bulmatown $BRIDGETOWN_SITE/src/_layouts
+exit
 
-**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.)
+# 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/example/yarn.lock

@@ -1533,10 +1533,10 @@ bulma@^0.9:
   resolved "https://registry.yarnpkg.com/bulma/-/bulma-0.9.0.tgz#948c5445a49e9d7546f0826cb3820d17178a814f"
   integrity sha512-rV75CJkubNUroAt0qCRkjznZLoaXq/ctfMXsMvKSL84UetbSyx5REl96e8GoQ04G4Tkw0XF3STECffTOQrbzOQ==
 
-bulmatown@^1.0.0:
-  version "1.0.2"
-  resolved "https://registry.yarnpkg.com/bulmatown/-/bulmatown-1.0.2.tgz#d791813163eb51dbd44c86782545cb8500f47931"
-  integrity sha512-2tPbxIDhi/LSHO6QZP24Jnt/3cAe8fGKb8ArAEjXI9zeiPCgbbj/x56bQc221PgHCC5dbavp/NsNm5wgxUKPRA==
+bulmatown@1.0.3:
+  version "1.0.3"
+  resolved "https://registry.yarnpkg.com/bulmatown/-/bulmatown-1.0.3.tgz#e5e0c8ebde08d138867775cb13501b43d85f6150"
+  integrity sha512-J8Hr6l1WKSuPilict5bMGna8g4Q/j0fGGJbCfKlUx43iS3zFVW9fln+IZdti/v/dC4QKd5bXgbrS1lVb576axg==
   dependencies:
     bridgetown-quick-search "^1.0.3"
     bulma "^0.9"

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.0.4"
 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.4",
   "main": "frontend/javascript/index.js",
   "repository": {
     "type": "git",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bulmatown
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Jared White
@@ -139,8 +139,6 @@ 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
@@ -186,7 +184,7 @@ homepage: https://github.com/whitefusionhq/bulmatown
 licenses:
 - MIT
 metadata:
-  yarn-add: bulmatown@1.0.3
+  yarn-add: bulmatown@1.0.4
 post_install_message: 
 rdoc_options: []
 require_paths:

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 }})