jekyll-theme-fica 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
- data/.github/workflows/.ci_BASE_2002.yaml.swp +0 -0
- data/.github/workflows/.ci_LOCAL_2002.yaml.swp +0 -0
- data/.github/workflows/.ci_REMOTE_2002.yaml.swp +0 -0
- data/.github/workflows/ci.yaml +7 -0
- data/.github/workflows/ci.yaml.orig +34 -0
- data/.github/workflows/ci_BACKUP_2002.yaml +34 -0
- data/.github/workflows/ci_BASE_2002.yaml +27 -0
- data/.github/workflows/ci_LOCAL_2002.yaml +27 -0
- data/.github/workflows/ci_REMOTE_2002.yaml +27 -0
- data/README.md +4 -3
- data/_includes/Footer.html +112 -85
- data/_includes/Head.html +12 -13
- data/_includes/Header.html +17 -34
- data/_includes/{BTT.html → assets/BTT.html} +8 -7
- data/_includes/{Google-Analytics.html → assets/Google-Analytics.html} +12 -12
- data/_includes/assets/anchor-headings.html +164 -0
- data/_includes/assets/comments.html +16 -0
- data/_includes/assets/toc.html +174 -0
- data/_layouts/default.html +16 -14
- data/_layouts/home.html +25 -67
- data/_layouts/page.html +5 -3
- data/_layouts/post.html +50 -52
- data/_layouts/post_home.html +112 -112
- data/_posts/2022-04-5-Getting-Started.md +150 -149
- data/_sass/{layouts/base.scss → base.scss} +472 -579
- data/_sass/{themes/dark theme/highlight.scss → colors/dark-theme/highlight.scss} +362 -362
- data/_sass/{themes/dark theme/theme-dark.scss → colors/dark-theme/theme-dark.scss} +132 -142
- data/_sass/{themes/light theme/highlight.scss → colors/light-theme/highlight.scss} +198 -198
- data/_sass/{themes/light theme/theme-light.scss → colors/light-theme/theme-light.scss} +126 -136
- data/_sass/jekyll-theme-fica.scss +1 -8
- data/_sass/layouts/component.scss +253 -0
- data/_sass/layouts/layout.scss +612 -718
- data/_sass/layouts/variable.scss +201 -0
- data/assets/css/Style.scss +12 -13
- data/bin/run +195 -150
- data/js/Main.js +21 -0
- data/js/back-to-top.js +39 -48
- metadata +28 -16
- data/_sass/custom/styles.scss +0 -1
- data/_sass/custom/variables.scss +0 -1
- data/_sass/layouts/variables.scss +0 -230
- data/docs/contributing.md +0 -69
data/_layouts/post_home.html
CHANGED
@@ -1,113 +1,113 @@
|
|
1
|
-
---
|
2
|
-
layout: default
|
3
|
-
---
|
4
|
-
<div class="home">
|
5
|
-
<h1 class="
|
6
|
-
|
7
|
-
{%- if site.paginate -%}
|
8
|
-
{% assign pinned = site.posts | where: "pin", "true" %}
|
9
|
-
{% assign default = site.posts | where_exp: "item", "item.pin != true" %}
|
10
|
-
|
11
|
-
{% assign posts = "" | split: "" %}
|
12
|
-
|
13
|
-
<!-- Get pinned posts -->
|
14
|
-
|
15
|
-
{% assign offset = paginator.page | minus: 1 | times: paginator.per_page %}
|
16
|
-
{% assign pinned_num = pinned.size | minus: offset %}
|
17
|
-
|
18
|
-
{% if pinned_num > 0 %}
|
19
|
-
{% for i in (offset..pinned.size) limit: pinned_num %}
|
20
|
-
{% assign posts = posts | push: pinned[i] %}
|
21
|
-
{% endfor %}
|
22
|
-
{% else %}
|
23
|
-
{% assign pinned_num = 0 %}
|
24
|
-
{% endif %}
|
25
|
-
|
26
|
-
|
27
|
-
<!-- Get default posts -->
|
28
|
-
|
29
|
-
{% assign default_beg = offset | minus: pinned.size %}
|
30
|
-
|
31
|
-
{% if default_beg < 0 %}
|
32
|
-
{% assign default_beg = 0 %}
|
33
|
-
{% endif %}
|
34
|
-
|
35
|
-
{% assign default_num = paginator.posts | size | minus: pinned_num %}
|
36
|
-
{% assign default_end = default_beg | plus: default_num | minus: 1 %}
|
37
|
-
|
38
|
-
{% if default_num > 0 %}
|
39
|
-
{% for i in (default_beg..default_end) %}
|
40
|
-
{% assign posts = posts | push: default[i] %}
|
41
|
-
{% endfor %}
|
42
|
-
{% endif %}
|
43
|
-
{% else %}
|
44
|
-
{% assign posts = site.posts %}
|
45
|
-
{% endif %}
|
46
|
-
|
47
|
-
|
48
|
-
{%- if posts.size > 0 -%}
|
49
|
-
<div class="post-list">
|
50
|
-
{%- assign date_format = site.date_format | default: "%b %-d, %Y" -%}
|
51
|
-
{%- for post in posts -%}
|
52
|
-
<
|
53
|
-
<a class="post-link" href="{{ post.url | relative_url }}">
|
54
|
-
{{ post.title | escape }}
|
55
|
-
</a>
|
56
|
-
<div class="post-info">
|
57
|
-
{%- assign date_format_tooltip = site.fica.date_format | default: "%b%-d, %Y" -%}
|
58
|
-
<span class="post-info-date">{{ post.date | date: date_format }}</span>
|
59
|
-
{% if post.pin %}
|
60
|
-
<span class="post-info-pin">
|
61
|
-
<span class="material-icons-round">
|
62
|
-
push_pin
|
63
|
-
</span>
|
64
|
-
<p>pinned</p>
|
65
|
-
</span>
|
66
|
-
{%- endif -%}
|
67
|
-
</div>
|
68
|
-
{%- if site.show_descriptions -%}
|
69
|
-
{{ post.excerpt }}
|
70
|
-
{%- endif -%}
|
71
|
-
</
|
72
|
-
{%- endfor -%}
|
73
|
-
</div>
|
74
|
-
|
75
|
-
{%- if site.paginate -%}
|
76
|
-
<ul class="post-nav">
|
77
|
-
<li>
|
78
|
-
{% if paginator.previous_page %}
|
79
|
-
<a href="{{ paginator.previous_page_path | relative_url }}">
|
80
|
-
<span class="material-icons-round post-nav-svg">
|
81
|
-
arrow_back_ios
|
82
|
-
</span>
|
83
|
-
</a>
|
84
|
-
{% else %}
|
85
|
-
<a>
|
86
|
-
<span class="material-icons-round post-nav-svg disable-svg">
|
87
|
-
chevron_left
|
88
|
-
</span>
|
89
|
-
</a>
|
90
|
-
{% endif %}
|
91
|
-
</li>
|
92
|
-
<li class="post-nav-num">{{ paginator.page }}
|
93
|
-
/
|
94
|
-
{{ paginator.total_pages }}</li>
|
95
|
-
<li>
|
96
|
-
{%- if paginator.next_page %}
|
97
|
-
<a href="{{ paginator.next_page_path | relative_url }}">
|
98
|
-
<span class="material-icons-round post-nav-svg">
|
99
|
-
arrow_forward_ios
|
100
|
-
</span>
|
101
|
-
</a>
|
102
|
-
{%- else %}
|
103
|
-
<a>
|
104
|
-
<span class="material-icons-round post-nav-svg disable-svg">
|
105
|
-
chevron_right
|
106
|
-
</span>
|
107
|
-
</a>
|
108
|
-
{%- endif %}
|
109
|
-
</li>
|
110
|
-
</ul>
|
111
|
-
{%- endif %}
|
112
|
-
{%- endif -%}
|
1
|
+
---
|
2
|
+
layout: default
|
3
|
+
---
|
4
|
+
<div class="home">
|
5
|
+
<h1 class="post-title">{{ page.site-title }}</h1>
|
6
|
+
|
7
|
+
{%- if site.paginate -%}
|
8
|
+
{% assign pinned = site.posts | where: "pin", "true" %}
|
9
|
+
{% assign default = site.posts | where_exp: "item", "item.pin != true" %}
|
10
|
+
|
11
|
+
{% assign posts = "" | split: "" %}
|
12
|
+
|
13
|
+
<!-- Get pinned posts -->
|
14
|
+
|
15
|
+
{% assign offset = paginator.page | minus: 1 | times: paginator.per_page %}
|
16
|
+
{% assign pinned_num = pinned.size | minus: offset %}
|
17
|
+
|
18
|
+
{% if pinned_num > 0 %}
|
19
|
+
{% for i in (offset..pinned.size) limit: pinned_num %}
|
20
|
+
{% assign posts = posts | push: pinned[i] %}
|
21
|
+
{% endfor %}
|
22
|
+
{% else %}
|
23
|
+
{% assign pinned_num = 0 %}
|
24
|
+
{% endif %}
|
25
|
+
|
26
|
+
|
27
|
+
<!-- Get default posts -->
|
28
|
+
|
29
|
+
{% assign default_beg = offset | minus: pinned.size %}
|
30
|
+
|
31
|
+
{% if default_beg < 0 %}
|
32
|
+
{% assign default_beg = 0 %}
|
33
|
+
{% endif %}
|
34
|
+
|
35
|
+
{% assign default_num = paginator.posts | size | minus: pinned_num %}
|
36
|
+
{% assign default_end = default_beg | plus: default_num | minus: 1 %}
|
37
|
+
|
38
|
+
{% if default_num > 0 %}
|
39
|
+
{% for i in (default_beg..default_end) %}
|
40
|
+
{% assign posts = posts | push: default[i] %}
|
41
|
+
{% endfor %}
|
42
|
+
{% endif %}
|
43
|
+
{% else %}
|
44
|
+
{% assign posts = site.posts %}
|
45
|
+
{% endif %}
|
46
|
+
|
47
|
+
|
48
|
+
{%- if posts.size > 0 -%}
|
49
|
+
<div class="post-list">
|
50
|
+
{%- assign date_format = site.date_format | default: "%b %-d, %Y" -%}
|
51
|
+
{%- for post in posts -%}
|
52
|
+
<div class="post">
|
53
|
+
<a class="post-link" href="{{ post.url | relative_url }}">
|
54
|
+
{{ post.title | escape }}
|
55
|
+
</a>
|
56
|
+
<div class="post-info">
|
57
|
+
{%- assign date_format_tooltip = site.fica.date_format | default: "%b%-d, %Y" -%}
|
58
|
+
<span class="post-info-date">{{ post.date | date: date_format }}</span>
|
59
|
+
{% if post.pin %}
|
60
|
+
<span class="post-info-pin">
|
61
|
+
<span class="material-icons-round">
|
62
|
+
push_pin
|
63
|
+
</span>
|
64
|
+
<p>pinned</p>
|
65
|
+
</span>
|
66
|
+
{%- endif -%}
|
67
|
+
</div>
|
68
|
+
{%- if site.show_descriptions -%}
|
69
|
+
{{ post.excerpt }}
|
70
|
+
{%- endif -%}
|
71
|
+
</div>
|
72
|
+
{%- endfor -%}
|
73
|
+
</div>
|
74
|
+
|
75
|
+
{%- if site.paginate -%}
|
76
|
+
<ul class="post-nav">
|
77
|
+
<li>
|
78
|
+
{% if paginator.previous_page %}
|
79
|
+
<a href="{{ paginator.previous_page_path | relative_url }}">
|
80
|
+
<span class="material-icons-round post-nav-svg">
|
81
|
+
arrow_back_ios
|
82
|
+
</span>
|
83
|
+
</a>
|
84
|
+
{% else %}
|
85
|
+
<a>
|
86
|
+
<span class="material-icons-round post-nav-svg disable-svg">
|
87
|
+
chevron_left
|
88
|
+
</span>
|
89
|
+
</a>
|
90
|
+
{% endif %}
|
91
|
+
</li>
|
92
|
+
<li class="post-nav-num">{{ paginator.page }}
|
93
|
+
/
|
94
|
+
{{ paginator.total_pages }}</li>
|
95
|
+
<li>
|
96
|
+
{%- if paginator.next_page %}
|
97
|
+
<a href="{{ paginator.next_page_path | relative_url }}">
|
98
|
+
<span class="material-icons-round post-nav-svg">
|
99
|
+
arrow_forward_ios
|
100
|
+
</span>
|
101
|
+
</a>
|
102
|
+
{%- else %}
|
103
|
+
<a>
|
104
|
+
<span class="material-icons-round post-nav-svg disable-svg">
|
105
|
+
chevron_right
|
106
|
+
</span>
|
107
|
+
</a>
|
108
|
+
{%- endif %}
|
109
|
+
</li>
|
110
|
+
</ul>
|
111
|
+
{%- endif %}
|
112
|
+
{%- endif -%}
|
113
113
|
</div>
|
@@ -1,149 +1,150 @@
|
|
1
|
-
---
|
2
|
-
layout: post
|
3
|
-
site-title: Getting Started
|
4
|
-
author: Involts
|
5
|
-
pin: true
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
{
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
1
|
+
---
|
2
|
+
layout: post
|
3
|
+
site-title: Getting Started
|
4
|
+
author: Involts
|
5
|
+
pin: true
|
6
|
+
post_toc: true
|
7
|
+
---
|
8
|
+
|
9
|
+
# Prerequisites
|
10
|
+
|
11
|
+
Follow the instructions in [jekyll Docs](https://jekyllrb.com/docs/installation/) to install `Ruby`, `RubyGems`, and `Bundler`. You may also install [Git](https://git-scm.com/)
|
12
|
+
|
13
|
+
# Installation
|
14
|
+
|
15
|
+
## Creating a new site
|
16
|
+
|
17
|
+
1. [Using RubyGems](https://rubygems.org/gems/jekyll-theme-fica) - Easy to upgrade, but it is not convenient with customizing the Theme.
|
18
|
+
|
19
|
+
1. [Forking using Github](https://github.com/Involts/jekyll-theme-fica/generate) - Not easy to upgrade, but you needs familiar with [Jekyll](https://jekyllrb.com), [Git](https://git-scm.com/) or [Github](https://github.com/).
|
20
|
+
|
21
|
+
## Option 1. Using RubyGems
|
22
|
+
|
23
|
+
Copy the Gemfile `gem 'jekyll-theme-fica', '~> 0.2.0'`, paste it on the `Gemfile` file then run
|
24
|
+
|
25
|
+
```bash
|
26
|
+
$ bin/run insdep
|
27
|
+
```
|
28
|
+
{: .nolineno}
|
29
|
+
or
|
30
|
+
```bash
|
31
|
+
$ bundle install
|
32
|
+
```
|
33
|
+
{: .nolineno}
|
34
|
+
|
35
|
+
and run
|
36
|
+
|
37
|
+
```bash
|
38
|
+
$ bin/run server
|
39
|
+
```
|
40
|
+
{: .nolineno}
|
41
|
+
or
|
42
|
+
```bash
|
43
|
+
$ bundle exec jekyll serve
|
44
|
+
```
|
45
|
+
{: .nolineno}
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
|
50
|
+
## Option 2. Forking Github
|
51
|
+
|
52
|
+
name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
|
53
|
+
|
54
|
+
then run:
|
55
|
+
|
56
|
+
```bash
|
57
|
+
$ bin/run insdep
|
58
|
+
```
|
59
|
+
{: .nolineno}
|
60
|
+
|
61
|
+
and run
|
62
|
+
|
63
|
+
```bash
|
64
|
+
$ bin/run server
|
65
|
+
```
|
66
|
+
{: .nolineno}
|
67
|
+
|
68
|
+
# Usage
|
69
|
+
|
70
|
+
### Configuration
|
71
|
+
|
72
|
+
> Before publishing the site to github-pages, replace the varable of baseurl. If you have brought a doman remove the varable in the `_config.yml` file
|
73
|
+
`baseurl: /jekyll-fica-theme`
|
74
|
+
{: .prompt-warning }
|
75
|
+
|
76
|
+
Fica Theme will respect the following variables, in your `_config.yml` file:
|
77
|
+
|
78
|
+
```yml
|
79
|
+
title: [The title of your site]
|
80
|
+
description: [A short description of your site's purpose]
|
81
|
+
|
82
|
+
socials:
|
83
|
+
# Change Involts to your full name.
|
84
|
+
name: [The auther of the site]
|
85
|
+
# it also be the copyright owner's link
|
86
|
+
auther-link: [Link of the auther]
|
87
|
+
```
|
88
|
+
|
89
|
+
Change the links of your site header:
|
90
|
+
|
91
|
+
```yml
|
92
|
+
header:
|
93
|
+
external_link_1: true # if false, it adds the baseurl of the site
|
94
|
+
header_name_1: Download
|
95
|
+
header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
|
96
|
+
|
97
|
+
external_link_2: false # if false, it adds the baseurl of the site
|
98
|
+
header_name_2: Post
|
99
|
+
header_link_2: /Post/
|
100
|
+
|
101
|
+
external_link_3: false # if false, it adds the baseurl of the site
|
102
|
+
header_name_3: About
|
103
|
+
header_link_3: /About/
|
104
|
+
```
|
105
|
+
|
106
|
+
Change the links of your site header:
|
107
|
+
|
108
|
+
> If you want to create a external link in the headers Links remove `{{site.baseurl}}` on `_includes/Header/html` **BELLOW**
|
109
|
+
{: .prompt-info }
|
110
|
+
|
111
|
+
|
112
|
+
{% raw %}
|
113
|
+
```diff
|
114
|
+
header:
|
115
|
+
external_link_1: true # if false, it adds the baseurl of the site
|
116
|
+
header_name_1: Download
|
117
|
+
header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
|
118
|
+
- external_link_2: false # if false, it adds the baseurl of the site
|
119
|
+
+ external_link_2: true # if false, it adds the baseurl of the site
|
120
|
+
header_name_2: Post
|
121
|
+
header_link_2: /Post/
|
122
|
+
|
123
|
+
- external_link_3: false # if false, it adds the baseurl of the site
|
124
|
+
+ external_link_3: true # if false, it adds the baseurl of the site
|
125
|
+
header_name_3: About
|
126
|
+
header_link_3: /About/
|
127
|
+
```
|
128
|
+
{% endraw %}
|
129
|
+
|
130
|
+
# Upgrading
|
131
|
+
Depending on how you use the theme:
|
132
|
+
|
133
|
+
- if you are using the [theme gem](https://rubygems.org/gems/jekyll-theme-fica). Run:
|
134
|
+
|
135
|
+
```bash
|
136
|
+
$ bin/run upgrade
|
137
|
+
```
|
138
|
+
{: .nolineno}
|
139
|
+
|
140
|
+
Please refer to the [Upgrade Guide](https://github.com/Involts/jekyll-theme-fica/wiki/Theme-Upgrade-Guide) to keep your repo’s files in sync with the latest version of the theme.
|
141
|
+
|
142
|
+
- If you [forked](https://github.com/Involts/jekyll-theme-fica/fork) it on [GitHub](https://github.com/Involts/jekyll-theme-fica), then merge the [latest tags](https://github.com/Involts/jekyll-theme-fica/tags) into your Jekyll site to complete the upgrade. The merge is likely to conflict with your local modifications. Please be patient and careful to resolve these conflicts.
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|