jekyll-theme-digitalebrain 0.1.4 → 0.1.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +49 -52
  3. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: d692382c8dc553b061afa37a07c532a6b05951c3
4
- data.tar.gz: fbe5530a4daf35ec022f34d3df2b2409767537ad
3
+ metadata.gz: 2a773b958a14edcad2726e4f5d5adac640869b7f
4
+ data.tar.gz: 3adaf73cae854faf93aca1e88155a3d656d919f2
5
5
  SHA512:
6
- metadata.gz: 1fbab88e826f293f6cbb9be59058d7c66534d8971f4e4acb9e33b71c94fc97835e8d721c0b311ffd99f649fd47d5c0c1477e8f447d00e61e20ca01ac41ff35f0
7
- data.tar.gz: 2c36596b12a93850e4896db2de60026777506e58ef8fc925f6ae3bd8b9b3dcaf1e1d8a3d8003d40bd591a059bfb5c22277df3548cbded79fd9056fcb27754208
6
+ metadata.gz: 9f42cbbedaf4b40b29da5080406fb6cdc447b6aeb52c93fc773439c0c4a5ba01df9c6129ac36e81c67ec4aec46b8bdf658a4b2a3615c8f40c2b89cb18289d444
7
+ data.tar.gz: 5faeaa936c09c37edcc94a5a464f0f8f0689171b4b882055b43b7984590a3bdbc2fb7dd1a796f0812927b1c31324d48effc06b2c932a2b4ee3d50632fb590281
data/README.md CHANGED
@@ -1,52 +1,49 @@
1
- # jekyll-theme-digitalebrain
2
-
3
- Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
4
-
5
- To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
6
-
7
- TODO: Delete this and the text above, and describe your gem
8
-
9
-
10
- ## Installation
11
-
12
- Add this line to your Jekyll site's `Gemfile`:
13
-
14
- ```ruby
15
- gem "jekyll-theme-digitalebrain"
16
- ```
17
-
18
- And add this line to your Jekyll site's `_config.yml`:
19
-
20
- ```yaml
21
- theme: jekyll-theme-digitalebrain
22
- ```
23
-
24
- And then execute:
25
-
26
- $ bundle
27
-
28
- Or install it yourself as:
29
-
30
- $ gem install jekyll-theme-digitalebrain
31
-
32
- ## Usage
33
-
34
- TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
35
-
36
- ## Contributing
37
-
38
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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.
39
-
40
- ## Development
41
-
42
- To set up your environment to develop this theme, run `bundle install`.
43
-
44
- Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
45
-
46
- When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
47
- To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-digitalebrain.gemspec` accordingly.
48
-
49
- ## License
50
-
51
- The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
52
-
1
+ # Jekyll-theme-DigitaleBrain
2
+
3
+ # Install as Gem Theme
4
+ Jekyll requires Ruby so make sure Ruby is installed before you begin.
5
+
6
+ ### Start a New Site
7
+ - Install Jekyll and Bundler
8
+ - `gem install bundler`
9
+ - Create a New Site
10
+ - `jekyl new mysite`
11
+ - Move into that directory
12
+ - `cd mysite`
13
+ - Install Required Gems
14
+ - `bundle install`
15
+ - Verify
16
+ - Run `jekyll serve`
17
+ - Browse to [http://localhost:4000](http://localhost:4000)
18
+ - Download Starving Artist Theme
19
+ - Replace the line `gem "minima"` with this:
20
+ - `gem "jekyll-theme-digitalebrain"`
21
+ - Run `bundle install`
22
+ - Tell Jekyll to use Starving Artist Theme
23
+ - Open `_config.yml` and change the line `theme: minima` to this:
24
+ - `theme: jekyll-theme-digitalebrain`
25
+
26
+
27
+ ### Migrate an Existing Site
28
+ **NOTE** This requires you to be upgraded to at least Jekyll 3.2 which added support for themes.
29
+
30
+ - Download Starving Artist Theme
31
+ - Replace the line `gem "minima"` with this:
32
+ - `gem "jekyll-theme-digitalebrain"`
33
+ - Run `bundle install`
34
+ - Tell Jekyll to use Starving Artist Theme
35
+ - Open `_config.yml` and change the line `theme: minima` to this:
36
+ - `theme: jekyll-theme-digitalebrain`
37
+
38
+ # Jekyll 2.x Method
39
+ Jekyll requires Ruby so make sure Ruby is installed before you begin.
40
+
41
+ - Download this site
42
+ - `git clone https://github.com/digitalebrain/digitalejk.git`
43
+ - Move into its directory
44
+ - `cd digitalejk`
45
+ - Install Required Gems
46
+ - `bundle install`
47
+ - Verify
48
+ - Run `jekyll serve`
49
+ - Browse to [http://localhost:4000](http://localhost:4000)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-digitalebrain
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.4
4
+ version: 0.1.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Pablo Cisneros