jekyll-bootstrap-quickstart 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a3b9ce73306630f6778b7cd5dfaafe122dc097d5878e968a15b2c2399ea2c54
-  data.tar.gz: 1a4dfa5c222e8fa4d80289e71a587ccccaf5f75b8a89f39c81a825af962c1023
+  metadata.gz: 1fe1aae21093d06b49b4c434099c4c51e3a88e7c3e5edd5d93e12d93036dd7cb
+  data.tar.gz: b08eca72da2e698b205af9cc7985fb2f90ee22c2ac790570cb3c4d8997b6d214
 SHA512:
-  metadata.gz: a271597ed0ae4f95d82fab805b19087f6d847011b70736e764c35622cc72385f787e329c969c9cd294ca603745bbc13fc671591afd247e6f17c5ebc644874fce
-  data.tar.gz: e32413fcce6a4452e51f53c4ed6a8bdbf437743e7ea6f0996dc8c3eca20b46dab4edb61377f065bbbb3b82f6ea521e87fb42f762068f8fc82ad3d84164d21fdd
+  metadata.gz: bf4f2a3881a498e0dcb48378469d6ec442e29aaa2cd9d66ffb5cc2adfe3bd28b5c1e6ae2f962bcba0c549b853a5c93a01ab250eb1af54ad9b6f190a9eb1053f0
+  data.tar.gz: 33d22016da9858207d723d592e48722a02717ca2e03f71dd4dc43df404526007ba08a3cc422e549eac4c7169ddb50f13aed4f2cdef328d30a2b5f32d1194da18

data/README.md

@@ -18,91 +18,116 @@ theme: jekyll-bootstrap-quickstart
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install jekyll-bootstrap-quickstart
+```shell
+$ gem install jekyll-bootstrap-quickstart
+```
 
 ## Usage
 
-### Layouts
+#### Layouts
  - Default
+ - Home
+ - No CSS / JS (used for Error Page)
  - Page
- - Error
+ - Post
 
-### Includes
+#### Includes
  - Build Version
  - Favicons
+ - Post Feed
  - Google Analytics
  - Head Tag (including CSS Imports)
- - js Imports
+ - Header
+ - JS Imports
 
 ## Customization
 
-### Styling
+#### Styling
 
 Add custom styles by overriding the `assets/css/main.scss` file. Copy this import statement to include all the Bootstrap and Jekyll Quickstart CSS. To start with a clean slate just leave this out.
-```
+```scss
 ---
 ---
 
-// Import custom styles from Sass file
-@import "jqs-styles"
+// Import custom styles and Bootstrap from Sass files
+
+/*! Jekyll Quickstart CSS
+* 
+*/
+
+/* Show it is fixed to the top */
+.fixed-header-body {
+  padding-top: 5rem;
+}
+
+// Jekyll Minima Syntax Highlighting
+@import "minima-syntax-highlighting";
+
+// Import Bootstrap CSS
+@import "lib/bootstrap/bootstrap";
 
 ```
 
-### Javascript
+#### Javascript
 Add custom JS to `assets/js.main.js`
 
+#### Favicons
+Need to be at `assets/img/favicons/`
+
 ## Development
 
 To set up your environment to develop this theme (Assumes macOS):
 
-### Clone Jekyll Quickstart Repo
+#### Clone Jekyll Quickstart Repo
 [https://bitbucket.org/azaleahill/jekyll-quickstart/](https://bitbucket.org/azaleahill/jekyll-quickstart/)
 
-### Homebrew
+#### Homebrew
 Install Homebrew. [https://brew.sh/](https://brew.sh/)
-```
+```shell
 $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 ```
 
-### Node, npm, and yarn
+#### Node, npm, and yarn
 This project uses yarn as a package manger, and is also compatible with npm. [https://www.npmjs.com/](https://www.npmjs.com/) [https://yarnpkg.com/](https://yarnpkg.com/)
-```
+```shell
 $ brew install node
 $ brew install yarn
 ```
 
-### Ruby
+#### Ruby
 Jekyll is built on Ruby. [https://www.ruby-lang.org/](https://www.ruby-lang.org/)
 Install with Homebrew to ensure proper environment variables and permissions.
-```
+```shell
 $ brew install ruby
 ```
 
-### Bundler
+#### Bundler
 Bundler is a Ruby Gem / package dependency manager. [http://bundler.io/](http://bundler.io/)
-```
+```shell
 $ gem install bundler
 ```
 
-### Jekyll
+#### Jekyll
 [https://jekyllrb.com/](https://jekyllrb.com/)
-```
+```shell
 $ gem install jekyll
 ```
 
 ## Project Setup
 Run install steps for yarn and Bundler
-```
+```shell
 $ yarn install
 ```
 
 ## Run App Locally
 See package.json for all available scripts. Run the app locally by executing the following:
-```
+```shell
 $ yarn start
 ```
 
@@ -115,7 +140,7 @@ This will do the following:
 
 ## Build Instructions
 See package.json for all available scripts. Build the app for various environments by executing the applicable npm script below:
-```
+```shell
 $ yarn run build-local
 $ yarn run build-stage
 $ yarn run build-prod
@@ -123,32 +148,16 @@ $ yarn run build-prod
 
 ## Deployment
 **Requires the s3cmd**
-```
+```shell
 $ brew install s3cmd
 ```
 
 See package.json for all available scripts. Deploy the app for various environments by executing the applicable npm script below.
 See jekyll-ezdeploy README for more info
-```
+```shell
 $ yarn run deploy
 ```
 
-## Assumptions
-
-### Site Variables
- - title
- - production
- - env-name
- - theme-color
- - baseurl
- - ga_tracking_id
- - description
-
-### Favicons
-Need to be at `assets/img/favicons/`
-
-
-
 ## Contributing
 
 Bug reports and pull requests are welcome on BitBucket at [https://bitbucket.org/azaleahill/jekyll-quickstart/](https://bitbucket.org/azaleahill/jekyll-quickstart/) 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.

data/assets/css/main.scss

@@ -2,4 +2,18 @@
 ---
 
 // Import custom styles and Bootstrap from Sass files
-@import "jqs-styles"
+
+/*! Jekyll Quickstart CSS
+* 
+*/
+
+/* Show it is fixed to the top */
+.fixed-header-body {
+  padding-top: 5rem;
+}
+
+// Jekyll Minima Syntax Highlighting
+@import "minima-syntax-highlighting";
+
+// Import Bootstrap CSS
+@import "lib/bootstrap/bootstrap";

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-bootstrap-quickstart
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Azalea Hill, Inc.
@@ -103,7 +103,6 @@ files:
 - _layouts/jqs-no-css-js.html
 - _layouts/jqs-page.html
 - _layouts/jqs-post.html
-- _sass/jqs-styles.scss
 - _sass/minima-syntax-highlighting.scss
 - assets/css/bs-blog.css
 - assets/css/main.scss

data/_sass/jqs-styles.scss

@@ -1,13 +0,0 @@
-/*! Jekyll Quickstart CSS 
-*/
-
-/* Show it is fixed to the top */
-.fixed-header-body {
-  padding-top: 5rem;
-}
-
-// Import Bootstrap CSS
-@import "../node_modules/bootstrap/scss/bootstrap.scss";
-
-// Jekyll Minima Syntax Highlighting
-@import "minima-syntax-highlighting";