jekyll-theme-fica 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- 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.yaml +5 -2
- data/.github/workflows/ci.yaml.orig +34 -0
- data/404.html +12 -10
- data/License.md +2 -8
- data/README.md +53 -49
- data/_includes/Footer.html +88 -85
- data/_includes/Head.html +24 -12
- data/_includes/Header.html +21 -34
- data/_includes/assets/BTT.html +8 -0
- 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 +48 -52
- data/_layouts/post_list.html +103 -0
- data/_posts/2022-03-31-To-Know-if-the-nav-works.md +9 -8
- data/_posts/{2022-04-1-Demo.md → 2022-04-1-Elements-of-Fica-Theme.md} +111 -113
- data/_posts/2022-04-5-Getting-Started.md +149 -149
- data/_posts/2022-04-6-Creating-a-new-post.md +144 -136
- data/_posts/2023-04-24-Fica-Customization.md +43 -0
- data/_sass/base.scss +437 -0
- 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/Google-fonts.scss +103 -138
- data/_sass/layouts/component.scss +272 -0
- data/_sass/layouts/layout.scss +657 -718
- data/_sass/layouts/typography.scss +492 -0
- data/_sass/layouts/variable.scss +215 -0
- data/assets/css/Style.scss +4 -13
- data/assets/favicons/android-chrome-192x192.png +0 -0
- data/assets/favicons/android-chrome-512x512.png +0 -0
- data/assets/favicons/apple-touch-icon.png +0 -0
- data/assets/favicons/browserconfig.xml +9 -0
- data/assets/favicons/favicon-16x16.png +0 -0
- data/assets/favicons/favicon-32x32.png +0 -0
- data/assets/favicons/favicon.ico +0 -0
- data/assets/favicons/mstile-150x150.png +0 -0
- data/assets/favicons/safari-pinned-tab.svg +32 -0
- data/assets/favicons/site.webmanifest +19 -0
- data/assets/img/homepage-pic.png +0 -0
- data/bin/run +195 -150
- data/js/Main.js +74 -0
- data/js/back-to-top.js +39 -48
- data/logo.png +0 -0
- data/post/index.html +3 -3
- metadata +35 -32
- data/_includes/BTT.html +0 -7
- data/_layouts/post_home.html +0 -113
- data/_sass/custom/styles.scss +0 -1
- data/_sass/custom/variables.scss +0 -1
- data/_sass/layouts/base.scss +0 -579
- data/_sass/layouts/variables.scss +0 -230
- data/docs/contributing.md +0 -69
@@ -0,0 +1,103 @@
|
|
1
|
+
---
|
2
|
+
layout: default
|
3
|
+
---
|
4
|
+
<h1 class="site-post-list-title">{{ page.site-title }}</h1>
|
5
|
+
|
6
|
+
{%- if site.paginate -%}
|
7
|
+
{% assign pinned = site.posts | where: "pin", "true" %}
|
8
|
+
{% assign default = site.posts | where_exp: "item", "item.pin != true" %}
|
9
|
+
|
10
|
+
{% assign posts = "" | split: "" %}
|
11
|
+
|
12
|
+
<!-- Get pinned posts -->
|
13
|
+
|
14
|
+
{% assign offset = paginator.page | minus: 1 | times: paginator.per_page %}
|
15
|
+
{% assign pinned_num = pinned.size | minus: offset %}
|
16
|
+
|
17
|
+
{% if pinned_num > 0 %}
|
18
|
+
{% for i in (offset..pinned.size) limit: pinned_num %}
|
19
|
+
{% assign posts = posts | push: pinned[i] %}
|
20
|
+
{% endfor %}
|
21
|
+
{% else %}
|
22
|
+
{% assign pinned_num = 0 %}
|
23
|
+
{% endif %}
|
24
|
+
|
25
|
+
|
26
|
+
<!-- Get default posts -->
|
27
|
+
|
28
|
+
{% assign default_beg = offset | minus: pinned.size %}
|
29
|
+
|
30
|
+
{% if default_beg < 0 %} {% assign default_beg=0 %} {% endif %} {% assign default_num=paginator.posts | size | minus:
|
31
|
+
pinned_num %} {% assign default_end=default_beg | plus: default_num | minus: 1 %} {% if default_num> 0 %}
|
32
|
+
{% for i in (default_beg..default_end) %}
|
33
|
+
{% assign posts = posts | push: default[i] %}
|
34
|
+
{% endfor %}
|
35
|
+
{% endif %}
|
36
|
+
{% else %}
|
37
|
+
{% assign posts = site.posts %}
|
38
|
+
{% endif %}
|
39
|
+
|
40
|
+
|
41
|
+
{%- if posts.size > 0 -%}
|
42
|
+
<div class="post-list">
|
43
|
+
{%- assign date_format = site.date_format | default: "%b %-d, %Y" -%}
|
44
|
+
{%- for post in posts -%}
|
45
|
+
<div class="post-container">
|
46
|
+
<a class="post" href="{{ post.url | relative_url }}">
|
47
|
+
<p class="post-header">
|
48
|
+
{{ post.title | escape }}
|
49
|
+
</p>
|
50
|
+
<div class="post-info">
|
51
|
+
{%- assign date_format_tooltip = site.fica.date_format | default: "%b%-d, %Y" -%}
|
52
|
+
<span class="post-info-date">{{ post.date | date: date_format }}</span>
|
53
|
+
{% if post.pin %}
|
54
|
+
<span class="post-info-pin">
|
55
|
+
<span class="material-icons-round">
|
56
|
+
push_pin
|
57
|
+
</span>
|
58
|
+
<p>pinned</p>
|
59
|
+
</span>
|
60
|
+
{%- endif -%}
|
61
|
+
</div>
|
62
|
+
<div class="post-descriptions">
|
63
|
+
{%- if site.show_descriptions -%}
|
64
|
+
{{ post.excerpt }}
|
65
|
+
{%- endif -%}
|
66
|
+
</div>
|
67
|
+
|
68
|
+
</a>
|
69
|
+
|
70
|
+
</div>
|
71
|
+
{%- endfor -%}
|
72
|
+
</div>
|
73
|
+
|
74
|
+
{%- if site.paginate -%}
|
75
|
+
<ul class="post-nav">
|
76
|
+
<li>
|
77
|
+
{% if paginator.previous_page %}
|
78
|
+
<a href="{{ paginator.previous_page_path | relative_url }}" class="material-icons-round post-nav-svg">
|
79
|
+
arrow_back_ios
|
80
|
+
</a>
|
81
|
+
{% else %}
|
82
|
+
<a class="material-icons-round post-nav-svg disable-svg">
|
83
|
+
chevron_left
|
84
|
+
</a>
|
85
|
+
{% endif %}
|
86
|
+
</li>
|
87
|
+
<li class="post-nav-num">{{ paginator.page }}
|
88
|
+
/
|
89
|
+
{{ paginator.total_pages }}</li>
|
90
|
+
<li>
|
91
|
+
{%- if paginator.next_page %}
|
92
|
+
<a href="{{ paginator.next_page_path | relative_url }}" class="material-icons-round post-nav-svg">
|
93
|
+
arrow_forward_ios
|
94
|
+
</a>
|
95
|
+
{%- else %}
|
96
|
+
<a class="material-icons-round post-nav-svg disable-svg">
|
97
|
+
chevron_right
|
98
|
+
</a>
|
99
|
+
{%- endif %}
|
100
|
+
</li>
|
101
|
+
</ul>
|
102
|
+
{%- endif %}
|
103
|
+
{%- endif -%}
|
@@ -1,8 +1,9 @@
|
|
1
|
-
---
|
2
|
-
layout: post
|
3
|
-
site-title: To Know if the nav works
|
4
|
-
author: Involts
|
5
|
-
modified_date: 2022-04-3
|
6
|
-
|
7
|
-
|
8
|
-
|
1
|
+
---
|
2
|
+
layout: post
|
3
|
+
site-title: To Know if the nav works
|
4
|
+
author: Involts
|
5
|
+
modified_date: 2022-04-3
|
6
|
+
post_toc: false
|
7
|
+
---
|
8
|
+
|
9
|
+
Lorem ipsum dolor sit amet consectetur adipisicing elit. Ullam maxime dolor incidunt eligendi eum magni velit, quam cum eos, quo reprehenderit blanditiis unde! Esse excepturi porro, inventore nulla quo eaque?Lorem ipsum dolor sit amet consectetur adipisicing elit. Ullam maxime dolor incidunt eligendi eum magni velit, quam cum eos, quo reprehenderit blanditiis unde! Esse excepturi porro, inventore nulla quo eaque?Lorem ipsum dolor sit amet consectetur adipisicing elit. Ullam maxime dolor incidunt eligendi eum magni velit, quam cum eos, quo reprehenderit blanditiis unde! Esse excepturi porro, inventore nulla quo eaque?Lorem ipsum dolor sit amet consectetur adipisicing elit. Ullam maxime dolor incidunt eligendi eum magni velit, quam cum eos, quo reprehenderit blanditiis unde! Esse excepturi porro, inventore nulla quo eaque?Lorem ipsum dolor sit amet consectetur adipisicing elit. Ullam maxime dolor incidunt eligendi eum magni velit, quam cum eos, quo reprehenderit blanditiis unde! Esse excepturi porro, inventore nulla quo eaque?Lorem ipsum dolor sit amet consectetur adipisicing elit. Ullam maxime dolor incidunt eligendi eum magni velit, quam cum eos, quo reprehenderit blanditiis unde! Esse excepturi porro, inventore nulla quo eaque?Lorem ipsum dolor sit amet consectetur adipisicing elit. Ullam maxime dolor incidunt eligendi eum magni velit, quam cum eos, quo reprehenderit blanditiis unde! Esse excepturi porro, inventore nulla quo eaque?
|
@@ -1,114 +1,112 @@
|
|
1
|
-
---
|
2
|
-
layout: post
|
3
|
-
site-title:
|
4
|
-
author: Involts
|
5
|
-
modified_date:
|
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
|
-
| lorem
|
62
|
-
| lorem ipsum dolor sit | lorem ipsum dolor sit | lorem ipsum dolor sit | lorem ipsum dolor sit |
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
```
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
<
|
80
|
-
<meta
|
81
|
-
<
|
82
|
-
<
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
- This is an unordered list following a header.
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
- level
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
- level
|
108
|
-
- level 2 item
|
109
|
-
|
110
|
-
- level 2 item
|
111
|
-
- level
|
112
|
-
- level 2 item
|
113
|
-
- level 2 item
|
1
|
+
---
|
2
|
+
layout: post
|
3
|
+
site-title: Elements of Fica Theme
|
4
|
+
author: Involts
|
5
|
+
modified_date: 2023-04-14
|
6
|
+
---
|
7
|
+
|
8
|
+
# Paragraph
|
9
|
+
|
10
|
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
11
|
+
|
12
|
+
|
13
|
+
Nullam placerat massa ex, at gravida neque pharetra ac. Morbi scelerisque id lorem elementum vulputate.
|
14
|
+
|
15
|
+
Sed eu lectus a erat placerat consequat id ut elit. Suspendisse potenti. Sed eu orci est.
|
16
|
+
|
17
|
+
Phasellus id sodales leo. Quisque sit amet urna ex.
|
18
|
+
|
19
|
+
In hac habitasse platea dictumst. Maecenas tincidunt mauris a rutrum pharetra.Etiam sed est risus.
|
20
|
+
|
21
|
+
Integer scelerisque lacus id neque tempor tincidunt.
|
22
|
+
|
23
|
+
Vivamus ac suscipit eros, in sollicitudin velit.
|
24
|
+
|
25
|
+
Nam at odio quam. Curabitur magna libero, suscipit sed venenatis vel, interdum vitae neque.
|
26
|
+
|
27
|
+
|
28
|
+
# headings
|
29
|
+
---
|
30
|
+
# Lorem ipsum
|
31
|
+
## Lorem ipsum
|
32
|
+
### Lorem ipsum
|
33
|
+
#### Lorem ipsum
|
34
|
+
##### Lorem ipsum
|
35
|
+
###### Lorem ipsum
|
36
|
+
---
|
37
|
+
# Prompts
|
38
|
+
---
|
39
|
+
|
40
|
+
> An example showing the `Tip` Prompt
|
41
|
+
{: .prompt-tip }
|
42
|
+
|
43
|
+
|
44
|
+
> An example showing the `Info` Prompt
|
45
|
+
{: .prompt-info }
|
46
|
+
|
47
|
+
> An example showing the `Warning` Prompt
|
48
|
+
{: .prompt-warning }
|
49
|
+
|
50
|
+
> An example showing the `Danger` Prompt
|
51
|
+
{: .prompt-danger }
|
52
|
+
|
53
|
+
---
|
54
|
+
|
55
|
+
# Table
|
56
|
+
|
57
|
+
| Title 1 | Title 2 | Title 3 | Title 4 |
|
58
|
+
| --------------------- | --------------------- | --------------------- | --------------------- |
|
59
|
+
| lorem | lorem ipsum | lorem ipsum dolor | lorem ipsum dolor sit |
|
60
|
+
| lorem ipsum dolor sit | lorem ipsum dolor sit | lorem ipsum dolor sit | lorem ipsum dolor sit |
|
61
|
+
| lorem ipsum dolor sit | lorem ipsum dolor sit | lorem ipsum dolor sit | lorem ipsum dolor sit |
|
62
|
+
| lorem ipsum dolor sit | lorem ipsum dolor sit | lorem ipsum dolor sit | lorem ipsum dolor sit |
|
63
|
+
|
64
|
+
|
65
|
+
# Code Block
|
66
|
+
|
67
|
+
```js
|
68
|
+
// Javascript code with syntax highlighting.
|
69
|
+
var fun = function lang(l) {
|
70
|
+
dateformat.i18n = require("./lang/" + l);
|
71
|
+
return true;
|
72
|
+
};
|
73
|
+
```
|
74
|
+
|
75
|
+
```html
|
76
|
+
# Html code with syntax highlighting
|
77
|
+
<head>
|
78
|
+
<meta charset="utf-8" />
|
79
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
80
|
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
81
|
+
<link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
|
82
|
+
<title>{{page.site-title}}</title>
|
83
|
+
</head>
|
84
|
+
```
|
85
|
+
|
86
|
+
# Unordered list
|
87
|
+
|
88
|
+
- This is an unordered list following a header.
|
89
|
+
- This is an unordered list following a header.
|
90
|
+
- This is an unordered list following a header.
|
91
|
+
|
92
|
+
# Ordered list
|
93
|
+
|
94
|
+
1. This is an ordered list following a header.
|
95
|
+
2. This is an ordered list following a header.
|
96
|
+
3. This is an ordered list following a header.
|
97
|
+
|
98
|
+
# And a nested list:
|
99
|
+
|
100
|
+
- level 1 item
|
101
|
+
- level 2 item
|
102
|
+
- level 2 item
|
103
|
+
- level 3 item
|
104
|
+
- level 3 item
|
105
|
+
- level 1 item
|
106
|
+
- level 2 item
|
107
|
+
- level 2 item
|
108
|
+
- level 2 item
|
109
|
+
- level 1 item
|
110
|
+
- level 2 item
|
111
|
+
- level 2 item
|
114
112
|
- level 1 item
|
@@ -1,149 +1,149 @@
|
|
1
|
-
---
|
2
|
-
layout: post
|
3
|
-
site-title: Getting Started
|
4
|
-
author: Involts
|
5
|
-
pin: true
|
6
|
-
---
|
7
|
-
|
8
|
-
# Prerequisites
|
9
|
-
|
10
|
-
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/)
|
11
|
-
|
12
|
-
# Installation
|
13
|
-
|
14
|
-
## Creating a new site
|
15
|
-
|
16
|
-
1. [Using RubyGems](https://rubygems.org/gems/jekyll-theme-fica) - Easy to upgrade, but it is not convenient with customizing the Theme.
|
17
|
-
|
18
|
-
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/).
|
19
|
-
|
20
|
-
## Option 1. Using RubyGems
|
21
|
-
|
22
|
-
Copy the Gemfile `gem 'jekyll-theme-fica', '~> 0.2.0'`, paste it on the `Gemfile` file then run
|
23
|
-
|
24
|
-
```bash
|
25
|
-
$ bin/run insdep
|
26
|
-
```
|
27
|
-
{: .nolineno}
|
28
|
-
or
|
29
|
-
```bash
|
30
|
-
$ bundle install
|
31
|
-
```
|
32
|
-
{: .nolineno}
|
33
|
-
|
34
|
-
and run
|
35
|
-
|
36
|
-
```bash
|
37
|
-
$ bin/run server
|
38
|
-
```
|
39
|
-
{: .nolineno}
|
40
|
-
or
|
41
|
-
```bash
|
42
|
-
$ bundle exec jekyll serve
|
43
|
-
```
|
44
|
-
{: .nolineno}
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
## Option 2. Forking Github
|
50
|
-
|
51
|
-
name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
|
52
|
-
|
53
|
-
then run:
|
54
|
-
|
55
|
-
```bash
|
56
|
-
$ bin/run insdep
|
57
|
-
```
|
58
|
-
{: .nolineno}
|
59
|
-
|
60
|
-
and run
|
61
|
-
|
62
|
-
```bash
|
63
|
-
$ bin/run server
|
64
|
-
```
|
65
|
-
{: .nolineno}
|
66
|
-
|
67
|
-
# Usage
|
68
|
-
|
69
|
-
### Configuration
|
70
|
-
|
71
|
-
> 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
|
72
|
-
`baseurl: /jekyll-fica-theme`
|
73
|
-
{: .prompt-warning }
|
74
|
-
|
75
|
-
Fica Theme will respect the following variables, in your `_config.yml` file:
|
76
|
-
|
77
|
-
```yml
|
78
|
-
title: [The title of your site]
|
79
|
-
description: [A short description of your site's purpose]
|
80
|
-
|
81
|
-
socials:
|
82
|
-
# Change Involts to your full name.
|
83
|
-
name: [The auther of the site]
|
84
|
-
# it also be the copyright owner's link
|
85
|
-
|
86
|
-
```
|
87
|
-
|
88
|
-
Change the links of your site header:
|
89
|
-
|
90
|
-
```yml
|
91
|
-
header:
|
92
|
-
external_link_1: true # if false, it adds the baseurl of the site
|
93
|
-
header_name_1: Download
|
94
|
-
header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
|
95
|
-
|
96
|
-
external_link_2: false # if false, it adds the baseurl of the site
|
97
|
-
header_name_2: Post
|
98
|
-
header_link_2: /Post/
|
99
|
-
|
100
|
-
external_link_3: false # if false, it adds the baseurl of the site
|
101
|
-
header_name_3: About
|
102
|
-
header_link_3: /About/
|
103
|
-
```
|
104
|
-
|
105
|
-
Change the links of your site header:
|
106
|
-
|
107
|
-
> If you want to create a external link in the headers Links remove `{{site.baseurl}}` on `_includes/Header/html` **BELLOW**
|
108
|
-
{: .prompt-info }
|
109
|
-
|
110
|
-
|
111
|
-
{% raw %}
|
112
|
-
```diff
|
113
|
-
header:
|
114
|
-
external_link_1: true # if false, it adds the baseurl of the site
|
115
|
-
header_name_1: Download
|
116
|
-
header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
|
117
|
-
- external_link_2: false # if false, it adds the baseurl of the site
|
118
|
-
+ external_link_2: true # if false, it adds the baseurl of the site
|
119
|
-
header_name_2: Post
|
120
|
-
header_link_2: /Post/
|
121
|
-
|
122
|
-
- external_link_3: false # if false, it adds the baseurl of the site
|
123
|
-
+ external_link_3: true # if false, it adds the baseurl of the site
|
124
|
-
header_name_3: About
|
125
|
-
header_link_3: /About/
|
126
|
-
```
|
127
|
-
{% endraw %}
|
128
|
-
|
129
|
-
# Upgrading
|
130
|
-
Depending on how you use the theme:
|
131
|
-
|
132
|
-
- if you are using the [theme gem](https://rubygems.org/gems/jekyll-theme-fica). Run:
|
133
|
-
|
134
|
-
```bash
|
135
|
-
$ bin/run upgrade
|
136
|
-
```
|
137
|
-
{: .nolineno}
|
138
|
-
|
139
|
-
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.
|
140
|
-
|
141
|
-
- 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.
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
1
|
+
---
|
2
|
+
layout: post
|
3
|
+
site-title: Getting Started
|
4
|
+
author: Involts
|
5
|
+
pin: true
|
6
|
+
---
|
7
|
+
|
8
|
+
# Prerequisites
|
9
|
+
|
10
|
+
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/)
|
11
|
+
|
12
|
+
# Installation
|
13
|
+
|
14
|
+
## Creating a new site
|
15
|
+
|
16
|
+
1. [Using RubyGems](https://rubygems.org/gems/jekyll-theme-fica) - Easy to upgrade, but it is not convenient with customizing the Theme.
|
17
|
+
|
18
|
+
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/).
|
19
|
+
|
20
|
+
## Option 1. Using RubyGems
|
21
|
+
|
22
|
+
Copy the Gemfile `gem 'jekyll-theme-fica', '~> 0.2.0'`, paste it on the `Gemfile` file then run
|
23
|
+
|
24
|
+
```bash
|
25
|
+
$ bin/run insdep
|
26
|
+
```
|
27
|
+
{: .nolineno}
|
28
|
+
or
|
29
|
+
```bash
|
30
|
+
$ bundle install
|
31
|
+
```
|
32
|
+
{: .nolineno}
|
33
|
+
|
34
|
+
and run
|
35
|
+
|
36
|
+
```bash
|
37
|
+
$ bin/run server
|
38
|
+
```
|
39
|
+
{: .nolineno}
|
40
|
+
or
|
41
|
+
```bash
|
42
|
+
$ bundle exec jekyll serve
|
43
|
+
```
|
44
|
+
{: .nolineno}
|
45
|
+
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
## Option 2. Forking Github
|
50
|
+
|
51
|
+
name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
|
52
|
+
|
53
|
+
then run:
|
54
|
+
|
55
|
+
```bash
|
56
|
+
$ bin/run insdep
|
57
|
+
```
|
58
|
+
{: .nolineno}
|
59
|
+
|
60
|
+
and run
|
61
|
+
|
62
|
+
```bash
|
63
|
+
$ bin/run server
|
64
|
+
```
|
65
|
+
{: .nolineno}
|
66
|
+
|
67
|
+
# Usage
|
68
|
+
|
69
|
+
### Configuration
|
70
|
+
|
71
|
+
> 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
|
72
|
+
`baseurl: /jekyll-fica-theme`
|
73
|
+
{: .prompt-warning }
|
74
|
+
|
75
|
+
Fica Theme will respect the following variables, in your `_config.yml` file:
|
76
|
+
|
77
|
+
```yml
|
78
|
+
title: [The title of your site]
|
79
|
+
description: [A short description of your site's purpose]
|
80
|
+
|
81
|
+
socials:
|
82
|
+
# Change Involts to your full name.
|
83
|
+
name: [The auther of the site]
|
84
|
+
# it also be the copyright owner's link
|
85
|
+
author-link: [Link of the auther]
|
86
|
+
```
|
87
|
+
|
88
|
+
Change the links of your site header:
|
89
|
+
|
90
|
+
```yml
|
91
|
+
header:
|
92
|
+
external_link_1: true # if false, it adds the baseurl of the site
|
93
|
+
header_name_1: Download
|
94
|
+
header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
|
95
|
+
|
96
|
+
external_link_2: false # if false, it adds the baseurl of the site
|
97
|
+
header_name_2: Post
|
98
|
+
header_link_2: /Post/
|
99
|
+
|
100
|
+
external_link_3: false # if false, it adds the baseurl of the site
|
101
|
+
header_name_3: About
|
102
|
+
header_link_3: /About/
|
103
|
+
```
|
104
|
+
|
105
|
+
Change the links of your site header:
|
106
|
+
|
107
|
+
> If you want to create a external link in the headers Links remove `{{site.baseurl}}` on `_includes/Header/html` **BELLOW**
|
108
|
+
{: .prompt-info }
|
109
|
+
|
110
|
+
|
111
|
+
{% raw %}
|
112
|
+
```diff
|
113
|
+
header:
|
114
|
+
external_link_1: true # if false, it adds the baseurl of the site
|
115
|
+
header_name_1: Download
|
116
|
+
header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
|
117
|
+
- external_link_2: false # if false, it adds the baseurl of the site
|
118
|
+
+ external_link_2: true # if false, it adds the baseurl of the site
|
119
|
+
header_name_2: Post
|
120
|
+
header_link_2: /Post/
|
121
|
+
|
122
|
+
- external_link_3: false # if false, it adds the baseurl of the site
|
123
|
+
+ external_link_3: true # if false, it adds the baseurl of the site
|
124
|
+
header_name_3: About
|
125
|
+
header_link_3: /About/
|
126
|
+
```
|
127
|
+
{% endraw %}
|
128
|
+
|
129
|
+
# Upgrading
|
130
|
+
Depending on how you use the theme:
|
131
|
+
|
132
|
+
- if you are using the [theme gem](https://rubygems.org/gems/jekyll-theme-fica). Run:
|
133
|
+
|
134
|
+
```bash
|
135
|
+
$ bin/run upgrade
|
136
|
+
```
|
137
|
+
{: .nolineno}
|
138
|
+
|
139
|
+
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.
|
140
|
+
|
141
|
+
- 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.
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
|