chulapa-jekyll 1.0.0 → 1.0.1

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 -31
  3. metadata +2 -50
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 01b74df06b414b3f7a91a57e4752f465d015d49de4eb381b4935e1378606bfec
4
- data.tar.gz: 12fd46079fe2cbcdfe04a57841324dca42590b1a1f4464bf357ad5bea1dbb6be
3
+ metadata.gz: 4bb447fb57b3069adc4ef6a44c5123b9d39f1715d94a8d99b952d1541ff28494
4
+ data.tar.gz: 4bd1f9f950643c286b5c8ea68eb7463baf9ba5da8a0247184e98e82f4ec37a59
5
5
  SHA512:
6
- metadata.gz: 57392015f7ddf716eaeaaac862f8725b95273051b76ee38393d659a54a7ae88be170329cf0f3c342e18b219437f8fb0b71f6ae18ba0b90ca365d14f473dce422
7
- data.tar.gz: d781dac4d4298b96244f9712e118d4e085a9c4ef882be1925ec7f66d5adc3ca019c259f2a09eea191776dcf248757ea13fc4abc54aed511dbc1be6d5180a4dc9
6
+ metadata.gz: 6ac402bbb2587cb195793e5eaf28ab9b85e3fb4f5577eb45a14c73fb6c92fe5cd40d23add0d24c370cfbcc143f7f7a495e7b8451eae47560b7c55da6394b8bd6
7
+ data.tar.gz: f45670effa160e72e35b4f3e079fac92191107a15abb0c3adadf0f875ac74b18f1729acb4ecadce94a144e2768a91f47e72f951d710adb5082e1e02443a6d02e
data/README.md CHANGED
@@ -3,12 +3,13 @@
3
3
  [1]: https://dieghernan.github.io/chulapa/
4
4
  [2]: https://dieghernan.github.io/chulapa/assets/img/site/banner.png (live preview)
5
5
 
6
- ![GitHub release (latest by date)](https://img.shields.io/github/v/release/dieghernan/chulapa)
6
+ ![GitHub release (latest by date)](https://img.shields.io/github/v/release/dieghernan/chulapa)
7
+ ![Gem](https://img.shields.io/gem/v/chulapa-jekyll)
7
8
  ![GitHub](https://img.shields.io/github/license/dieghernan/chulapa)
8
9
  ![Jekyll](https://img.shields.io/badge/jekyll-3.8.7-blue)
9
10
  ![Bootstrap](https://img.shields.io/badge/bootstrap-4.5.0-blue)
10
- ![Fontawesome](https://img.shields.io/badge/fontawesome->6.x-blue)
11
- ![Algolia](https://img.shields.io/badge/algolia->4.7.0-blue)
11
+ ![Fontawesome](https://img.shields.io/badge/fontawesome-6.x-blue)
12
+ ![Algolia](https://img.shields.io/badge/algolia-4.7.0-blue)
12
13
  ![lunr](https://img.shields.io/badge/lunr-2.3.8-blue)
13
14
  ![mathjax](https://img.shields.io/badge/mathjax-2.7.1-blue)
14
15
  ![GHpages](https://img.shields.io/badge/gh--pages-ready-succes)
@@ -47,46 +48,63 @@
47
48
  A great alternative for blogs, news, portfolios and personal sites. Want to know more? [Go to Docs](https://dieghernan.github.io/chulapa/docs/01-install).
48
49
 
49
50
  ## Installation
50
- ### A. Remote theme method
51
51
 
52
- By using `jekyll-remote-theme` your repo would have remote access to the content of these folders:
52
+ Sample `_config` file [here](https://github.com/dieghernan/chulapa/blob/master/_config.yml).
53
53
 
54
- - `assets`
55
- - `_layouts`
56
- - `_includes`
57
- - `_sass`
54
+ There are three possible ways for installing Chulapa:
58
55
 
59
- This method allows you to get updates easily
60
56
 
61
- #### Fresh start
57
+ ### A. Use our Github Template
62
58
 
63
- Create a Github account, go to [chulapa-101 repo](https://github.com/dieghernan/chulapa-101), fork it and quickstart your site!
59
+ **Recommended if your are starting from scratch.**
64
60
 
65
- #### Migrate
61
+ Create a Github account, click [this link](https://github.com/dieghernan/chulapa-101/generate) and quickstart your site!
66
62
 
67
- You can migrate an existing page adding this line to your `_config.yml` and make sure to remove any previous theme or remote theme parameter:
68
-
69
- ```yaml
70
- remote_theme: dieghernan/chulapa
71
63
 
72
- ... more config options
73
- ```
74
-
64
+ ### B. Remote theme method
75
65
 
76
- ### B. Fork the base repository [Advance users only]
66
+ **Recommended if you are migrating a previous site.**
77
67
 
78
- You can fork [the base repo](https://github.com/dieghernan/chulapa/generate) and modify it. However, the site would be frozen at the moment of forking and it would make harder for you to get potential new features and upgrades.
68
+ If you prefer not to use the template, you can use the `jekyll-remote-theme` method.
69
+ Just follow these steps:
79
70
 
80
- The minimal files and folders you need are:
81
-
82
- - `assets`
83
- - `_layouts`
84
- - `_includes`
85
- - `_sass`
86
- - `Gemfile`
87
- - `_config.yml`
71
+ 1. Create a new GitHub repository or go to an existing one
72
+ 2. Add this line to your `_config.yml`:
88
73
 
89
- Sample `_config` file [here](https://github.com/dieghernan/chulapa/blob/master/_config.yml).
74
+ ``` yaml
75
+
76
+ remote_theme: dieghernan/chulapa
77
+
78
+ ... more config options
79
+ ```
80
+ 3. Remove other `remote_theme/theme` instances of your `_config.yml` file.
81
+
82
+ ### C. Gem-based method 💎
83
+
84
+ With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`, and `_sass` are stored in the theme’s gem, hidden from your immediate view.
85
+ This allows for easier installation and updating as you don’t have to manage any of the theme files.
86
+
87
+ To install as a Gem-based theme:
88
+
89
+ 1. Add the following to your `Gemfile`:
90
+
91
+ ``` ruby
92
+ gem "chulapa-jekyll"
93
+ ```
94
+
95
+ 2. Fetch and update bundled gems by running the following [Bundler](https://bundler.io/) command:
96
+
97
+ ``` bash
98
+ bundle
99
+ ```
100
+
101
+ 3. Set the `theme` in your project’s Jekyll `_config.yml` file:
102
+
103
+ ``` yaml
104
+ theme: chulapa-jekyll
105
+ ```
106
+
107
+ To update the theme run `bundle update`.
90
108
 
91
109
  ## Configuration and Layouts
92
110
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: chulapa-jekyll
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Diego H.
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-11-24 00:00:00.000000000 Z
11
+ date: 2022-11-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -30,20 +30,6 @@ dependencies:
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: '5.0'
33
- - !ruby/object:Gem::Dependency
34
- name: jekyll-github-metadata
35
- requirement: !ruby/object:Gem::Requirement
36
- requirements:
37
- - - "~>"
38
- - !ruby/object:Gem::Version
39
- version: '2.0'
40
- type: :runtime
41
- prerelease: false
42
- version_requirements: !ruby/object:Gem::Requirement
43
- requirements:
44
- - - "~>"
45
- - !ruby/object:Gem::Version
46
- version: '2.0'
47
33
  - !ruby/object:Gem::Dependency
48
34
  name: jekyll-paginate
49
35
  requirement: !ruby/object:Gem::Requirement
@@ -86,40 +72,6 @@ dependencies:
86
72
  - - "~>"
87
73
  - !ruby/object:Gem::Version
88
74
  version: '1.3'
89
- - !ruby/object:Gem::Dependency
90
- name: jekyll-redirect-from
91
- requirement: !ruby/object:Gem::Requirement
92
- requirements:
93
- - - "~>"
94
- - !ruby/object:Gem::Version
95
- version: '0.16'
96
- type: :runtime
97
- prerelease: false
98
- version_requirements: !ruby/object:Gem::Requirement
99
- requirements:
100
- - - "~>"
101
- - !ruby/object:Gem::Version
102
- version: '0.16'
103
- - !ruby/object:Gem::Dependency
104
- name: github-pages
105
- requirement: !ruby/object:Gem::Requirement
106
- requirements:
107
- - - ">="
108
- - !ruby/object:Gem::Version
109
- version: '1.0'
110
- - - "<"
111
- - !ruby/object:Gem::Version
112
- version: '99999.0'
113
- type: :runtime
114
- prerelease: false
115
- version_requirements: !ruby/object:Gem::Requirement
116
- requirements:
117
- - - ">="
118
- - !ruby/object:Gem::Version
119
- version: '1.0'
120
- - - "<"
121
- - !ruby/object:Gem::Version
122
- version: '99999.0'
123
75
  description:
124
76
  email:
125
77
  - diego.hernangomezherrero@gmail.com