r-jekyll-theme 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +95 -50
- data/_config.yml +6 -5
- metadata +17 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1556b75b1f0c59039aff046cd84bb423c163ced5e2799dbbc9c4d50d25f48721
|
|
4
|
+
data.tar.gz: c6d889c56ec02dd28ba42f09dfbfdc8d8eef119f9a413ad8e195813f23d5fa84
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bc7b3c413e97d41c28cc7e44800d8aa6d3eb29c85cb9ca043c89e8995070dd54911b09d50dc2bae035520cdf725854bbadc8decb9b6ce89cc7e56ef8b7393674
|
|
7
|
+
data.tar.gz: 49ba484ba6bb01cd1c9a7719ce020ce9fe85900ea4744e4786caa8b838e8e63dffbacc2f007fc27374322344aa01780f9d01ea7fa11fa0a119055ea25d07f0eb
|
data/README.md
CHANGED
|
@@ -1,55 +1,100 @@
|
|
|
1
1
|
# r-jekyll-theme
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
A simple red Jekyll theme with left navigation that's perfect for portfolios and resumes.
|
|
3
|
+
See the [sample r-jekyll-theme implementation](https://rafalkaron.github.io/r-jekyll-theme).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
6
|
+
You can install the github-remote or gem-based r-jekyll-theme. You can also fork the r-jekyll-theme GitHub repository.
|
|
7
|
+
|
|
8
|
+
### Preparing for the theme installation
|
|
9
|
+
You need to create a directory for your Jekyll site and initialize a `Gemfile`.
|
|
10
|
+
|
|
11
|
+
1. Create a directory in which you like to develop your site.
|
|
12
|
+
2. In the site directory, run `bundle init`
|
|
13
|
+
**Result:** A `Gemfile` is created.
|
|
14
|
+
|
|
15
|
+
### Installing the github-remote-theme
|
|
16
|
+
This is the recommended theme installation method if you plan to deploy your Jekyll site to GitHub-Pages.
|
|
17
|
+
|
|
18
|
+
1. To the `Gemfile`, add:
|
|
19
|
+
```ruby
|
|
20
|
+
gem "jekyll-remote-theme"
|
|
21
|
+
```
|
|
22
|
+
2. In the site directory, create a `_config.yml` file.
|
|
23
|
+
3. To the `_config.yml` file, add:
|
|
24
|
+
```yaml
|
|
25
|
+
plugins:
|
|
26
|
+
- jekyll-remote-theme
|
|
27
|
+
remote_theme: rafalkaron/r-jekyll-theme@main
|
|
28
|
+
```
|
|
29
|
+
4. Run `bundle`
|
|
30
|
+
|
|
31
|
+
### Installing the gem-based theme
|
|
32
|
+
This is the recommended theme installation method if you're into old school.
|
|
33
|
+
|
|
34
|
+
1. To the `Gemfile`, add:
|
|
35
|
+
```ruby
|
|
36
|
+
gem "r-jekyll-theme"
|
|
37
|
+
```
|
|
38
|
+
2. In the site directory, create a `_config.yml` file.
|
|
39
|
+
2. To the `_config.yml` file, add:
|
|
40
|
+
```yaml
|
|
41
|
+
theme: r-jekyll-theme
|
|
42
|
+
```
|
|
43
|
+
3. Run `bundle`
|
|
44
|
+
|
|
45
|
+
### Forking the theme GitHub repository
|
|
46
|
+
This is the recommended theme installation method if you want to heavily modify the template.
|
|
47
|
+
|
|
48
|
+
1. Fork the [r-jekyll-theme](https://github.com/rafalkaron/r-jekyll-theme) repository.
|
|
49
|
+
2. In the root directory of the forked repository, run `bundle`
|
|
50
|
+
|
|
51
|
+
## Configuration
|
|
52
|
+
The r-jekyll-theme requires little configuration. You just need to add some content and fill in the `_config.yml` file with your site data and contact information.
|
|
53
|
+
|
|
54
|
+
### Adding content
|
|
55
|
+
You add content by creating Markdown files in the root directory of your Jekyll site.
|
|
56
|
+
**NOTE:** You should start adding your content by creating the `index.md` file.
|
|
57
|
+
|
|
58
|
+
1. in the root directory of your Jekyll site, create a Markdown file.
|
|
59
|
+
For example, create the `index.md` file.
|
|
60
|
+
1. Open the file and add:
|
|
61
|
+
```markdown
|
|
62
|
+
---
|
|
63
|
+
layout: default
|
|
64
|
+
title: Home
|
|
65
|
+
order: "0"
|
|
66
|
+
---
|
|
11
67
|
```
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
68
|
+
where:
|
|
69
|
+
* `layout` is the site HTML template. Always use the `default` value.
|
|
70
|
+
* `title` is the page title that appears in the site navigation and in the web browser tab.
|
|
71
|
+
* `order` is the position of the page in the navigation.
|
|
72
|
+
1. Add content.
|
|
73
|
+
For reference, see [content.md](https://raw.githubusercontent.com/rafalkaron/r-jekyll-theme/main/content.md).
|
|
74
|
+
**TIP:** To keep your files organized, add any media files to the `assets` directory.
|
|
75
|
+
1. Save the Markdown file.
|
|
76
|
+
|
|
77
|
+
### Previewing your site
|
|
78
|
+
1. Set up your development environment by running `bundle install`
|
|
79
|
+
2. Run `bundle exec jekyll serve`
|
|
80
|
+
3. In your web browser, go to `http://localhost:4000`
|
|
81
|
+
4. Add pages, documents, data, styling etc.
|
|
82
|
+
For more information, see [Jekyll Home](https://jekyllrb.com/).
|
|
83
|
+
**Info:** As you modify the theme or add content, your site regenerates automatically in the web browser. However, to see any `_config.yml` updates, you need to restart the server.
|
|
84
|
+
|
|
85
|
+
### Configuring site metadata and contact info
|
|
86
|
+
You configure site metadata and contact information by editing the `_confing.yml` file. See the default [_config.yml](https://raw.githubusercontent.com/rafalkaron/r-jekyll-theme/main/_config.yml) file that you can customize.
|
|
87
|
+
|
|
88
|
+
### Styling
|
|
89
|
+
You can override the default styling by creating the `main.scss` file in the `assets` directory.
|
|
90
|
+
|
|
91
|
+
1. In the root directory of your Jekyll site, create the `assets` directory.
|
|
92
|
+
2. In the `assets` directory, create and open the `main.scss` file.
|
|
93
|
+
3. To the `main.scss` file, add:
|
|
94
|
+
```scss
|
|
95
|
+
---
|
|
96
|
+
---
|
|
97
|
+
@import "r";
|
|
17
98
|
```
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
$ bundle
|
|
22
|
-
|
|
23
|
-
Or install it yourself as:
|
|
24
|
-
|
|
25
|
-
$ gem install r-jekyll-theme
|
|
26
|
-
|
|
27
|
-
## Usage
|
|
28
|
-
|
|
29
|
-
### Data
|
|
30
|
-
|
|
31
|
-
* `contact.yml` - Edit this file to \
|
|
32
|
-
|
|
33
|
-
#### meta.yml
|
|
34
|
-
|
|
35
|
-
### Layouts
|
|
36
|
-
|
|
37
|
-
### SASS
|
|
38
|
-
|
|
39
|
-
## Contributing
|
|
40
|
-
|
|
41
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/rafalkaron/r-jekyll-theme. 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.
|
|
42
|
-
|
|
43
|
-
## Development
|
|
44
|
-
|
|
45
|
-
To set up your environment to develop this theme, run `bundle install`.
|
|
46
|
-
|
|
47
|
-
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.
|
|
48
|
-
|
|
49
|
-
When your theme is released, only the files in `_layouts`, `_includes`, `_sass`, `_data` and `assets` tracked with Git will be bundled.
|
|
50
|
-
To add a custom directory to your theme-gem, please edit the regexp in `r.gemspec` accordingly.
|
|
51
|
-
|
|
52
|
-
## License
|
|
53
|
-
|
|
54
|
-
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
55
|
-
|
|
99
|
+
5. Under the `@import "r";` rule, add your styling.
|
|
100
|
+
4. Save the `main.scss` file.
|
data/_config.yml
CHANGED
|
@@ -46,14 +46,15 @@ exclude:
|
|
|
46
46
|
- Gemfile
|
|
47
47
|
- Gemfile.lock
|
|
48
48
|
- README.md
|
|
49
|
+
- r-jekyll-theme.gemspec
|
|
49
50
|
markdown: kramdown
|
|
50
51
|
kramdown:
|
|
51
52
|
input: GFM
|
|
52
53
|
|
|
53
|
-
###
|
|
54
|
-
plugins:
|
|
55
|
-
- jekyll-remote-theme
|
|
56
|
-
remote_theme: rafalkaron/r-jekyll-theme@main
|
|
54
|
+
### GitHub-remote theme
|
|
55
|
+
#plugins:
|
|
56
|
+
# - jekyll-remote-theme
|
|
57
|
+
#remote_theme: rafalkaron/r-jekyll-theme@main
|
|
57
58
|
|
|
58
|
-
###
|
|
59
|
+
### Gem-based theme
|
|
59
60
|
#theme: r-jekyll-theme
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: r-jekyll-theme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- rafalkaron
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-12-
|
|
11
|
+
date: 2020-12-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -24,6 +24,20 @@ dependencies:
|
|
|
24
24
|
- - "~>"
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
26
|
version: '3.9'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: github-pages
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - ">="
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '0'
|
|
34
|
+
type: :runtime
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - ">="
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '0'
|
|
27
41
|
description:
|
|
28
42
|
email:
|
|
29
43
|
- rafalkaron@gmail.com
|
|
@@ -103,5 +117,5 @@ requirements: []
|
|
|
103
117
|
rubygems_version: 3.2.2
|
|
104
118
|
signing_key:
|
|
105
119
|
specification_version: 4
|
|
106
|
-
summary: A red portfolio theme.
|
|
120
|
+
summary: A red portfolio Jekyll theme.
|
|
107
121
|
test_files: []
|