jekyll-bootstrap-quickstart 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +133 -0
  4. metadata +117 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f5db74c10e9d7cbca5971d33baca9a3f6d4071055f56655ed36498a8096789dc
4
+ data.tar.gz: 23fc88e9d66765fb6349ac8aa9c00c033efbed88bc664e45f830d0901b84931f
5
+ SHA512:
6
+ metadata.gz: 6f2fb1d45ab388e26f069fb3d5a6eb76a646e30e9a0cba1c3fa5b6e7ca8a002c3cc241caa4d1ae085dd537e243974a788a4c291588c5e3f5a029fed95871fe83
7
+ data.tar.gz: f91786d149eb106678d20176fb671b0b8da94222751b0b6e423ca3bb2adca001267218b2c22c60987aa875517d62f3712a6bd4dbc10b3343ad88311b86f442a7
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2017-2018 Azalea Hill, Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,133 @@
1
+ # Jekyll Quickstart
2
+
3
+ This Quickstart includes Jekyll layouts and includes to structure a simple site, and also includes Bootstrap as a front end framework.
4
+
5
+ ## Clone Jekyll Quickstart Repo
6
+ [https://bitbucket.org/azaleahill/jekyll-quickstart/](https://bitbucket.org/azaleahill/jekyll-quickstart/)
7
+
8
+ ## Environment Setup
9
+ Assumes macOS
10
+
11
+ ### Homebrew
12
+ Install Homebrew. [https://brew.sh/](https://brew.sh/)
13
+ ```
14
+ $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
15
+ ```
16
+
17
+ ### Node, npm, and yarn
18
+ 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/)
19
+ ```
20
+ $ brew install node
21
+ $ brew install yarn
22
+ ```
23
+
24
+ ### Ruby
25
+ Jekyll is built on Ruby. [https://www.ruby-lang.org/](https://www.ruby-lang.org/)
26
+ Install with Homebrew to ensure proper environment variables and permissions.
27
+ ```
28
+ $ brew install ruby
29
+ ```
30
+
31
+ ### Bundler
32
+ Bundler is a Ruby Gem / package dependency manager. [http://bundler.io/](http://bundler.io/)
33
+ ```
34
+ $ gem install bundler
35
+ ```
36
+
37
+ ### Jekyll
38
+ [https://jekyllrb.com/](https://jekyllrb.com/)
39
+ ```
40
+ $ gem install jekyll
41
+ ```
42
+
43
+ ## Project Setup
44
+ Run install steps for yarn and Bundler
45
+ ```
46
+ $ yarn install
47
+ ```
48
+
49
+ ## Run App Locally
50
+ See package.json for all available scripts. Run the app locally by executing the following:
51
+ ```
52
+ $ yarn start
53
+ ```
54
+
55
+ Head on over to [http://localhost:2802/](http://localhost:2802/)
56
+
57
+ This will do the following:
58
+ - Run Jekyll Build
59
+ - Launching a development web server with livereload at http://localhost:2802/
60
+ - Watching and recompiling when chnages are saved
61
+
62
+ ## Build Instructions
63
+ See package.json for all available scripts. Build the app for various environments by executing the applicable npm script below:
64
+ ```
65
+ $ yarn run build-local
66
+ $ yarn run build-stage
67
+ $ yarn run build-prod
68
+ ```
69
+
70
+ ## Deployment
71
+ **Requires the s3cmd**
72
+ ```
73
+ $ brew install s3cmd
74
+ ```
75
+
76
+ See package.json for all available scripts. Deploy the app for various environments by executing the applicable npm script below.
77
+ See jekyll-ezdeploy README for more info
78
+ ```
79
+ $ yarn run deploy
80
+ ```
81
+
82
+ ## Assumptions
83
+
84
+ ### Site Variables
85
+ - title
86
+ - production
87
+ - env-name
88
+ - theme-color
89
+ - baseurl
90
+ - ga_tracking_id
91
+ - description
92
+
93
+ ### Favicons
94
+ Need to be at `assets/img/favicons/`
95
+
96
+ ## Usage
97
+
98
+ ### Layouts
99
+ - Default
100
+ - Page
101
+ - Error
102
+
103
+ ### Includes
104
+ - Build Version
105
+ - Favicons
106
+ - Google Analytics
107
+ - Head Tag (including CSS Imports)
108
+ - js Imports
109
+
110
+ ## Customization
111
+
112
+ ### Styling
113
+
114
+ 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.
115
+ ```
116
+ ---
117
+ ---
118
+
119
+ // Import custom styles from Sass file
120
+ @import "jqs-styles"
121
+
122
+ ```
123
+
124
+ ### Javascript
125
+ Add custom JS to `assets/js.main.js`
126
+
127
+ ## Contributing
128
+
129
+ 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.
130
+
131
+ ## License
132
+
133
+ The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
metadata ADDED
@@ -0,0 +1,117 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jekyll-bootstrap-quickstart
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Azalea Hill, Inc.
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2018-04-14 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: jekyll
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3.7'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '3.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: jekyll-feed
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.9'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.9'
41
+ - !ruby/object:Gem::Dependency
42
+ name: jekyll-seo-tag
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '2.4'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '2.4'
55
+ - !ruby/object:Gem::Dependency
56
+ name: jekyll-sitemap
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.2'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.2'
69
+ - !ruby/object:Gem::Dependency
70
+ name: bundler
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.16'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.16'
83
+ description:
84
+ email:
85
+ - opensrc@azaleahill.io
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - LICENSE
91
+ - README.md
92
+ homepage: https://jqs.azaleahill.io/
93
+ licenses:
94
+ - MIT
95
+ metadata:
96
+ plugin_type: theme
97
+ post_install_message:
98
+ rdoc_options: []
99
+ require_paths:
100
+ - lib
101
+ required_ruby_version: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - ">="
104
+ - !ruby/object:Gem::Version
105
+ version: '0'
106
+ required_rubygems_version: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ requirements: []
112
+ rubyforge_project:
113
+ rubygems_version: 2.7.6
114
+ signing_key:
115
+ specification_version: 4
116
+ summary: Basic Jekyll layouts and includes using Bootstrap.
117
+ test_files: []