jekyll-theme-fica 0.1.8 → 0.2.2

data/_posts/2022-04-5-Getting-Started.md

@@ -2,6 +2,8 @@
 layout: post
 site-title: Getting Started
 author: Involts
+pin: true
+post_toc: true
 ---
 
 # Prerequisites
@@ -18,22 +20,50 @@ Follow the instructions in [jekyll Docs](https://jekyllrb.com/docs/installation/
 
 ## Option 1. Using RubyGems
 
-Copy the Gemfile `gem 'jekyll-theme-fica', '~> 0.1.5'`, paste it on the `Gemfile` file then run `bin/build`
+Copy the Gemfile `gem 'jekyll-theme-fica', '~> 0.2.0'`, paste it on the `Gemfile` file then run 
+
+```bash
+$ bin/run insdep
+```
+{: .nolineno}
+or
+```bash
+$ bundle install
+```
+{: .nolineno}
+
+and run
+
+```bash
+$ bin/run server
+```
+{: .nolineno}
+or
+```bash
+$ bundle exec jekyll serve
+```
+{: .nolineno}
+
+
 
-> `bin/build` installs the dependencies and runs the server locally.
-{: .prompt-info }
 
 ## Option 2. Forking Github
 
 name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
 
-and then run:
+ then run:
 
+```bash
+$ bin/run insdep
 ```
-$ bin/build
+{: .nolineno}
+
+and run
+
+```bash
+$ bin/run server
 ```
-> `bin/build` installs the dependencies and runs the server locally.
-{: .prompt-info }
+{: .nolineno}
 
 # Usage
 
@@ -45,50 +75,67 @@ $ bin/build
 
 Fica Theme will respect the following variables, in your `_config.yml` file:
 
-```
+```yml
 title: [The title of your site]
-author: [The auther of the site]
-name: [The owner of the site]
 description: [A short description of your site's purpose]
+
+socials:
+  # Change Involts to your full name.
+  name: [The auther of the site]
+  # it also be the copyright owner's link
+  auther-link: [Link of the auther]
 ```
 
 Change the links of your site header:
 
 ```yml
 header:
-  header_name_1: Download
-  header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
-  header_name_2: Post
-  header_link_2: /Post/
-  header_name_3: About
-  header_link_3: /About/
+    external_link_1: true # if false, it adds the baseurl of the site
+    header_name_1: Download
+    header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
+
+    external_link_2: false # if false, it adds the baseurl of the site
+    header_name_2: Post
+    header_link_2: /Post/
+    
+    external_link_3: false # if false, it adds the baseurl of the site
+    header_name_3: About
+    header_link_3: /About/
 ```
 
+Change the links of your site header:
+
  > If you want to create a external link in the headers Links remove `{{site.baseurl}}` on `_includes/Header/html` **BELLOW**
  {: .prompt-info }
 
 
 {% raw %}
 ```diff
-  <div class="trigger">
-    <a class="page-link" href="{{site.header.header_link_1}}">{{site.header.header_name_1}}</a>
--    <a class="page-link" href="{{site.baseurl}}{{site.header.header_link_2}}">{{site.header.header_name_2}}<a>
--    <a class="page-link" href="{{site.baseurl}}{{site.header.header_link_3}}">{{site.header.header_name_3}}</a>
-+     <a class="page-link" href="{{site.header.header_link_2}}">{{site.header.header_name_2}}</a>
-+     <a class="page-link" href="{{site.header.header_link_3}}">{{site.header.header_name_3}}</a>
-  </div>
+header:
+    external_link_1: true # if false, it adds the baseurl of the site
+    header_name_1: Download
+    header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master
+-   external_link_2: false # if false, it adds the baseurl of the site
++   external_link_2: true # if false, it adds the baseurl of the site
+    header_name_2: Post
+    header_link_2: /Post/
+    
+-   external_link_3: false # if false, it adds the baseurl of the site
++   external_link_3: true # if false, it adds the baseurl of the site
+    header_name_3: About
+    header_link_3: /About/
   ```
 {% endraw %}  
 
 #  Upgrading
   Depending on how you use the theme:
 
-- if you are using the [theme gem](https://rubygems.org/gems/jekyll-theme-fica). There will be `gem 'jekyll-theme-fica'` in the `Gemfile`.  
+- if you are using the [theme gem](https://rubygems.org/gems/jekyll-theme-fica). Run:
 
-```diff
--  gem 'jekyll-theme-fica', '~> 0.1.4'
-+  gem 'jekyll-theme-fica', '~> 0.1.8'
+```bash
+$ bin/run upgrade
 ```
+{: .nolineno}
 
 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.
 

data/_posts/2022-04-6-Creating-a-new-post.md

@@ -1,124 +1,136 @@
----
-layout: post
-site-title: Creating a new post
-author: Involts
----
-
-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.
-
-# Creating a File and Naming a post
-
-Create a new file named `YYY-MM-DD-TITLE.EXTENSION` (.EXTENSION may be `.md` or `.markdown`) and put it on the `_posts` folder.
-
-# Font Matter
-
-Basic Font Matter
-
-|             Font Matter               |  Description
-| --------------------------------------|------------------
-| `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. 
-| `site-title`                          | This displays the website title. **EXCEPT THE HOMEPAGE**
-| `author`                              |  This is optional for the post because the authour is set on the `_config.yml` file.
-| `home`                                | **This is only for the homepage** It displays the website title so that you will not write the website title.
-
-Examples:
-
-- Homepage:
-
-```yml
----
-layout: home
-home: true
----
-
-```
-
-- About
-
-```yml
----
-layout: default
-site-title: About
-permalink: /About/
----
-
-```
-
-- Post Home
-
-```yml
----
-layout: post_home
-site-title: post
----
-```
-
-- Post
-
-```yml
----
-layout: post
-site-title: Creating a new post
-author: Involts
----
-```
-
-# Syntax
-
-- Inline Code
-
-```
-`inline code part`
-```
-
-- Code Block
-
-Markdown symbol ``` can easily create a code block as follows:
-
-```
-Plaintext Code Snippet.
-```
-### Specifying Language in Code Block
-
-  Markdown symbol ```{language} can easily create a code block as follows:
-
-````yml
-```yml
-    title: Fica Theme
-```
-````
-
-### Line Number
-
- 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:
-
-````markdown
-```bash
-echo 'No more line numbers'
-```
-{: .nolineno }
-````
-
-#### Liquid Codes
-
-If you want to display the `Liquid` snippet, surround the liquid code with `{% raw %}` and `{% endraw %}`:
-
-````markdown
-{% raw %}
-```liquid
-{% if product.title contains 'Pack' %}
-  This product's title contains the word Pack.
-{% endif %}
-```
-{% endraw %}
-````
-
-Or adding `render_with_liquid: false` (Requires Jekyll 4.0 or higher) to the post's YAML block.
-
-## Learn More
-
-For more knowledge about Jekyll posts, visit the [Jekyll Docs: Posts](https://jekyllrb.com/docs/posts/).
-
-
-
-
+---
+layout: post
+site-title: Creating a new post
+author: Involts
+---
+
+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.
+
+# Creating a File and Naming a post
+
+Create a new file named `YYY-MM-DD-TITLE.EXTENSION` (.EXTENSION may be `.md` or `.markdown`) and put it on the `_posts` folder.
+
+# Font Matter
+
+Basic Font Matter
+
+|             Font Matter               |  Description
+| --------------------------------------|------------------
+| `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. 
+| `site-title`                          | This displays the website title. **EXCEPT THE HOMEPAGE**
+| `author`                              |  This is optional for the post because the authour is set on the `_config.yml` file.
+| `home`                                | **This is only for the homepage** It displays the website title so that you will not write the website title.
+| `pin`                              | This pins the post to the top of the post-home layout.
+
+Examples:
+
+- Homepage:
+
+```yml
+---
+layout: home
+home: true
+---
+
+```
+
+- About
+
+```yml
+---
+layout: default
+site-title: About
+permalink: /About/
+---
+
+```
+
+- Post Home
+
+```yml
+---
+layout: post_home
+site-title: post
+---
+```
+
+- Post
+
+```yml
+---
+layout: post
+site-title: Creating a new post
+author: Involts
+---
+```
+
+if it is pinned:
+```yml
+---
+layout: post
+site-title: Creating a new post
+author: Involts
+pin: true
+---
+```
+
+
+# Syntax
+
+- Inline Code
+
+```
+`inline code part`
+```
+
+- Code Block
+
+Markdown symbol ``` can easily create a code block as follows:
+
+```
+Plaintext Code Snippet.
+```
+### Specifying Language in Code Block
+
+  Markdown symbol ```{language} can easily create a code block as follows:
+
+````yml
+```yml
+    title: Fica Theme
+```
+````
+
+### Line Number
+
+ 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:
+
+````markdown
+```bash
+echo 'No more line numbers'
+```
+{: .nolineno }
+````
+
+#### Liquid Codes
+
+If you want to display the `Liquid` snippet, surround the liquid code with `{% raw %}` and `{% endraw %}`:
+
+````markdown
+{% raw %}
+```liquid
+{% if product.title contains 'Pack' %}
+  This product's title contains the word Pack.
+{% endif %}
+```
+{% endraw %}
+````
+
+Or adding `render_with_liquid: false` (Requires Jekyll 4.0 or higher) to the post's YAML block.
+
+## Learn More
+
+For more knowledge about Jekyll posts, visit the [Jekyll Docs: Posts](https://jekyllrb.com/docs/posts/).
+
+
+
+