jekyll-theme-fica 0.1.5 → 0.2.0
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/workflows/ci.yaml +27 -0
- data/404.html +18 -0
- data/License.md +2 -0
- data/README.md +73 -86
- data/_includes/BTT.html +7 -0
- data/_includes/Footer.html +84 -71
- data/_includes/Google-Analytics.html +12 -10
- data/_includes/Head.html +12 -10
- data/_includes/Header.html +34 -28
- data/_layouts/default.html +14 -13
- data/_layouts/home.html +67 -48
- data/_layouts/page.html +3 -13
- data/_layouts/post.html +52 -34
- data/_layouts/post_home.html +113 -56
- data/_posts/2022-03-31-To-Know-if-the-nav-works.md +8 -0
- data/_posts/2022-04-1-Demo.md +114 -0
- data/_posts/2022-04-5-Getting-Started.md +149 -0
- data/_posts/2022-04-6-Creating-a-new-post.md +136 -0
- data/_sass/custom/styles.scss +1 -0
- data/_sass/custom/variables.scss +1 -0
- data/_sass/jekyll-theme-fica.scss +8 -0
- data/_sass/layouts/Google-fonts.scss +139 -0
- data/_sass/layouts/base.scss +579 -0
- data/_sass/layouts/layout.scss +718 -0
- data/_sass/layouts/variables.scss +230 -0
- data/_sass/themes/dark theme/highlight.scss +363 -0
- data/_sass/themes/dark theme/theme-dark.scss +142 -0
- data/_sass/themes/{Light_Theme.scss → light theme/highlight.scss } +199 -256
- data/_sass/themes/light theme/theme-light.scss +136 -0
- data/assets/404.svg +22 -0
- data/assets/css/Style.scss +13 -0
- data/assets/fica-icons.svg +64 -54
- data/assets/img/{fica_ad.png → homepage-pic.png} +0 -0
- data/bin/run +150 -0
- data/docs/contributing.md +69 -0
- data/js/back-to-top.js +48 -0
- data/post/index.html +4 -0
- metadata +47 -13
- data/_includes/Custom-Head.html +0 -9
- data/_sass/Base.scss +0 -401
- data/_sass/Custom-Styles.scss +0 -2
- data/_sass/Custom-Variables.scss +0 -1
- data/_sass/Initialize.scss +0 -71
- data/_sass/Layout.scss +0 -474
- data/_sass/themes/Dark_Theme.scss +0 -269
- data/assets/css/Styles.scss +0 -11
@@ -0,0 +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
|
+
auther-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
|
+
|
@@ -0,0 +1,136 @@
|
|
1
|
+
---
|
2
|
+
layout: post
|
3
|
+
site-title: Creating a new post
|
4
|
+
author: Involts
|
5
|
+
---
|
6
|
+
|
7
|
+
This post shows how to create a new post on the `Fica` Theme. Even if you have previous experience with Jekyll, this article is worth reading, because many features require specific variables to be set.
|
8
|
+
|
9
|
+
# Creating a File and Naming a post
|
10
|
+
|
11
|
+
Create a new file named `YYY-MM-DD-TITLE.EXTENSION` (.EXTENSION may be `.md` or `.markdown`) and put it on the `_posts` folder.
|
12
|
+
|
13
|
+
# Font Matter
|
14
|
+
|
15
|
+
Basic Font Matter
|
16
|
+
|
17
|
+
| Font Matter | Description
|
18
|
+
| --------------------------------------|------------------
|
19
|
+
| `layouts` | This specifies the layout file to use. It may be `home` layout for the homepage, `post` layout for post, `default` or `page` layout/s the original look of the site, and `post-home` layout for homepage of the post/s.
|
20
|
+
| `site-title` | This displays the website title. **EXCEPT THE HOMEPAGE**
|
21
|
+
| `author` | This is optional for the post because the authour is set on the `_config.yml` file.
|
22
|
+
| `home` | **This is only for the homepage** It displays the website title so that you will not write the website title.
|
23
|
+
| `pin` | This pins the post to the top of the post-home layout.
|
24
|
+
|
25
|
+
Examples:
|
26
|
+
|
27
|
+
- Homepage:
|
28
|
+
|
29
|
+
```yml
|
30
|
+
---
|
31
|
+
layout: home
|
32
|
+
home: true
|
33
|
+
---
|
34
|
+
|
35
|
+
```
|
36
|
+
|
37
|
+
- About
|
38
|
+
|
39
|
+
```yml
|
40
|
+
---
|
41
|
+
layout: default
|
42
|
+
site-title: About
|
43
|
+
permalink: /About/
|
44
|
+
---
|
45
|
+
|
46
|
+
```
|
47
|
+
|
48
|
+
- Post Home
|
49
|
+
|
50
|
+
```yml
|
51
|
+
---
|
52
|
+
layout: post_home
|
53
|
+
site-title: post
|
54
|
+
---
|
55
|
+
```
|
56
|
+
|
57
|
+
- Post
|
58
|
+
|
59
|
+
```yml
|
60
|
+
---
|
61
|
+
layout: post
|
62
|
+
site-title: Creating a new post
|
63
|
+
author: Involts
|
64
|
+
---
|
65
|
+
```
|
66
|
+
|
67
|
+
if it is pinned:
|
68
|
+
```yml
|
69
|
+
---
|
70
|
+
layout: post
|
71
|
+
site-title: Creating a new post
|
72
|
+
author: Involts
|
73
|
+
pin: true
|
74
|
+
---
|
75
|
+
```
|
76
|
+
|
77
|
+
|
78
|
+
# Syntax
|
79
|
+
|
80
|
+
- Inline Code
|
81
|
+
|
82
|
+
```
|
83
|
+
`inline code part`
|
84
|
+
```
|
85
|
+
|
86
|
+
- Code Block
|
87
|
+
|
88
|
+
Markdown symbol ``` can easily create a code block as follows:
|
89
|
+
|
90
|
+
```
|
91
|
+
Plaintext Code Snippet.
|
92
|
+
```
|
93
|
+
### Specifying Language in Code Block
|
94
|
+
|
95
|
+
Markdown symbol ```{language} can easily create a code block as follows:
|
96
|
+
|
97
|
+
````yml
|
98
|
+
```yml
|
99
|
+
title: Fica Theme
|
100
|
+
```
|
101
|
+
````
|
102
|
+
|
103
|
+
### Line Number
|
104
|
+
|
105
|
+
All languages except `plaintext`, `console`, and `terminal` will display line numbers. When you want to hide the line number of a code block, add the class `nolineno` to it:
|
106
|
+
|
107
|
+
````markdown
|
108
|
+
```bash
|
109
|
+
echo 'No more line numbers'
|
110
|
+
```
|
111
|
+
{: .nolineno }
|
112
|
+
````
|
113
|
+
|
114
|
+
#### Liquid Codes
|
115
|
+
|
116
|
+
If you want to display the `Liquid` snippet, surround the liquid code with `{% raw %}` and `{% endraw %}`:
|
117
|
+
|
118
|
+
````markdown
|
119
|
+
{% raw %}
|
120
|
+
```liquid
|
121
|
+
{% if product.title contains 'Pack' %}
|
122
|
+
This product's title contains the word Pack.
|
123
|
+
{% endif %}
|
124
|
+
```
|
125
|
+
{% endraw %}
|
126
|
+
````
|
127
|
+
|
128
|
+
Or adding `render_with_liquid: false` (Requires Jekyll 4.0 or higher) to the post's YAML block.
|
129
|
+
|
130
|
+
## Learn More
|
131
|
+
|
132
|
+
For more knowledge about Jekyll posts, visit the [Jekyll Docs: Posts](https://jekyllrb.com/docs/posts/).
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
@@ -0,0 +1 @@
|
|
1
|
+
// put your custom layout here!
|
@@ -0,0 +1 @@
|
|
1
|
+
// put your custom variables here!
|
@@ -0,0 +1,139 @@
|
|
1
|
+
@mixin material-icons {
|
2
|
+
font-family: 'Material Icons';
|
3
|
+
font-weight: normal;
|
4
|
+
font-style: normal;
|
5
|
+
font-size: 24px;
|
6
|
+
/* Preferred icon size */
|
7
|
+
display: inline-block;
|
8
|
+
line-height: 1;
|
9
|
+
text-transform: none;
|
10
|
+
letter-spacing: normal;
|
11
|
+
word-wrap: normal;
|
12
|
+
white-space: nowrap;
|
13
|
+
direction: ltr;
|
14
|
+
user-select: none;
|
15
|
+
-moz-user-select: none;
|
16
|
+
-khtml-user-select: none;
|
17
|
+
-webkit-user-select: none;
|
18
|
+
-o-user-select: none;
|
19
|
+
|
20
|
+
/* Support for all WebKit browsers. */
|
21
|
+
-webkit-font-smoothing: antialiased;
|
22
|
+
/* Support for Safari and Chrome. */
|
23
|
+
text-rendering: optimizeLegibility;
|
24
|
+
|
25
|
+
/* Support for Firefox. */
|
26
|
+
-moz-osx-font-smoothing: grayscale;
|
27
|
+
|
28
|
+
/* Support for IE. */
|
29
|
+
font-feature-settings: 'liga';
|
30
|
+
}
|
31
|
+
|
32
|
+
.material-icons {
|
33
|
+
@include material-icons();
|
34
|
+
}
|
35
|
+
|
36
|
+
/* Rules for sizing the icon. */
|
37
|
+
.material-icons.md-18 {
|
38
|
+
font-size: 18px;
|
39
|
+
}
|
40
|
+
|
41
|
+
.material-icons.md-24 {
|
42
|
+
font-size: 24px;
|
43
|
+
}
|
44
|
+
|
45
|
+
.material-icons.md-36 {
|
46
|
+
font-size: 36px;
|
47
|
+
}
|
48
|
+
|
49
|
+
.material-icons.md-48 {
|
50
|
+
font-size: 48px;
|
51
|
+
}
|
52
|
+
|
53
|
+
/* Rules for using icons as black on a light background. */
|
54
|
+
.material-icons.md-dark {
|
55
|
+
color: rgba(0, 0, 0, 0.54);
|
56
|
+
}
|
57
|
+
|
58
|
+
.material-icons.md-dark.md-inactive {
|
59
|
+
color: rgba(0, 0, 0, 0.26);
|
60
|
+
}
|
61
|
+
|
62
|
+
/* Rules for using icons as white on a dark background. */
|
63
|
+
.material-icons.md-light {
|
64
|
+
color: rgba(255, 255, 255, 1);
|
65
|
+
}
|
66
|
+
|
67
|
+
.material-icons.md-light.md-inactive {
|
68
|
+
color: rgba(255, 255, 255, 0.3);
|
69
|
+
}
|
70
|
+
|
71
|
+
/* fallback */
|
72
|
+
@font-face {
|
73
|
+
font-family: 'Material Icons';
|
74
|
+
font-style: normal;
|
75
|
+
font-weight: 400;
|
76
|
+
src: url(https://fonts.gstatic.com/s/materialicons/v128/flUhRq6tzZclQEJ-Vdg-IuiaDsNc.woff2) format('woff2');
|
77
|
+
}
|
78
|
+
/* fallback */
|
79
|
+
@font-face {
|
80
|
+
font-family: 'Material Icons Outlined';
|
81
|
+
font-style: normal;
|
82
|
+
font-weight: 400;
|
83
|
+
src: url(https://fonts.gstatic.com/s/materialiconsoutlined/v103/gok-H7zzDkdnRel8-DQ6KAXJ69wP1tGnf4ZGhUce.woff2) format('woff2');
|
84
|
+
}
|
85
|
+
/* fallback */
|
86
|
+
@font-face {
|
87
|
+
font-family: 'Material Icons Round';
|
88
|
+
font-style: normal;
|
89
|
+
font-weight: 400;
|
90
|
+
src: url(https://fonts.gstatic.com/s/materialiconsround/v102/LDItaoyNOAY6Uewc665JcIzCKsKc_M9flwmP.woff2) format('woff2');
|
91
|
+
}
|
92
|
+
|
93
|
+
.material-icons {
|
94
|
+
font-family: 'Material Icons';
|
95
|
+
font-weight: normal;
|
96
|
+
font-style: normal;
|
97
|
+
font-size: 24px;
|
98
|
+
line-height: 1;
|
99
|
+
letter-spacing: normal;
|
100
|
+
text-transform: none;
|
101
|
+
display: inline-block;
|
102
|
+
white-space: nowrap;
|
103
|
+
word-wrap: normal;
|
104
|
+
direction: ltr;
|
105
|
+
-webkit-font-feature-settings: 'liga';
|
106
|
+
-webkit-font-smoothing: antialiased;
|
107
|
+
}
|
108
|
+
|
109
|
+
.material-icons-outlined {
|
110
|
+
font-family: 'Material Icons Outlined';
|
111
|
+
font-weight: normal;
|
112
|
+
font-style: normal;
|
113
|
+
font-size: 24px;
|
114
|
+
line-height: 1;
|
115
|
+
letter-spacing: normal;
|
116
|
+
text-transform: none;
|
117
|
+
display: inline-block;
|
118
|
+
white-space: nowrap;
|
119
|
+
word-wrap: normal;
|
120
|
+
direction: ltr;
|
121
|
+
-webkit-font-feature-settings: 'liga';
|
122
|
+
-webkit-font-smoothing: antialiased;
|
123
|
+
}
|
124
|
+
|
125
|
+
.material-icons-round {
|
126
|
+
font-family: 'Material Icons Round';
|
127
|
+
font-weight: normal;
|
128
|
+
font-style: normal;
|
129
|
+
font-size: 24px;
|
130
|
+
line-height: 1;
|
131
|
+
letter-spacing: normal;
|
132
|
+
text-transform: none;
|
133
|
+
display: inline-block;
|
134
|
+
white-space: nowrap;
|
135
|
+
word-wrap: normal;
|
136
|
+
direction: ltr;
|
137
|
+
-webkit-font-feature-settings: 'liga';
|
138
|
+
-webkit-font-smoothing: antialiased;
|
139
|
+
}
|