f.weber/jekyll-theme-chirpy
Template
1
0
Fork 0
mirror of https://github.com/cotes2020/jekyll-theme-chirpy.git synced 2025-12-18 05:41:31 +00:00
Code Issues Packages Releases Activity

Update docs.

Browse Source
This commit is contained in:
Cotes Chung
2019-11-16 23:12:26 +08:00
parent bb60c9dcf8
commit 89aa2b9370
3 changed files with 122 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
_posts/2019-08-09-getting-started.md
View File

@@ -1,5 +1,5 @@
---
title: Getting Started
title: Getting started
date: 2019-08-09 20:55:00 +0800
categories: [Blogging, Tutorial]
tags: [getting started]
@@ -7,7 +7,7 @@ tags: [getting started]
## Preparation
First of all, follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In addition, to use the funny script tools, we also need to install [Python](https://www.python.org/downloads/)(version 3.5 or abover), [ruamel.yaml](https://pypi.org/project/ruamel.yaml/) and [fswatch](http://emcrisostomo.github.io/fswatch/getting.html).
Follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In addition, to use the funny script tools, we also need to install [Python](https://www.python.org/downloads/)(version 3.5 or abover), [ruamel.yaml](https://pypi.org/project/ruamel.yaml/) and [fswatch](http://emcrisostomo.github.io/fswatch/getting.html).
Next, [fork Chirpy](https://github.com/cotes2020/jekyll-theme-chirpy/fork) and then clone the replicated repository locally.
@@ -85,7 +85,7 @@ Open a brower and visit <http://127.0.0.1:4000>
## Deploying to GitHub Pages
Before the deployment begins, rename your project as `<username>.github.io` and ensure the `url` in `_config.yml` has been set to `https://<username>.github.io`.
Before the deployment begins, ensure the `url` in `_config.yml` has been set to `https://<username>.github.io`.
### Option 1: Built by GitHub Pages
@@ -112,7 +112,7 @@ It will automatically generates the *Latest Modified Date* and *Categories / Tag
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts will not work. If you want to use any another third-party Jekyll plugins, **your have to build locally rather than on GitHub Pages**.
**1**. On GitHub website, create a brand new repository with name `<username>.github.io`, then clone it locally.
**1**. On GitHub website, create a brand new repository with name `<username>.github.io` and then clone it locally.
**2**. Build your site by:

14
_posts/2019-08-11-customize-the-favicon.md
View File

@@ -6,23 +6,21 @@ tags: [favicon]
toc: false
---
The image files of [Favicons](https://www.favicon-generator.org/about/) are placed in `assets/img/favicons`. You may need to replace them with your own. So let's see how to customize these Favicons.
In [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/), the image files of [Favicons](https://www.favicon-generator.org/about/) are placed in `assets/img/favicons/`. You may need to replace them with your own. So let's see how to customize these Favicons.
Whit a square image (PNG, JPG or GIF) in hand, open the site [*Favicon & App Icon Generator*](https://www.favicon-generator.org/) and upload your original image.
![upload-image]({{ site.baseurl }}/assets/img/sample/upload-image.png)
![upload-image](/assets/img/sample/upload-image.png)
Click button <kbd>Create Favicon</kbd> and wait a moment for the website to generate the icons of various sizes automatically.
![download-icons]({{ site.baseurl }}/assets/img/sample/download-icons.png)
![download-icons](/assets/img/sample/download-icons.png)
Download the generated package and extract, then remove the following two of them:
Download the generated package, unzip and delete the following two from the extracted files:
- browserconfig.xml
- manifest.json
Now, copy the rest (`.PNG` and `.ICO`) to cover the original files in folder `assets/img/favicons`.
In the end, rebuild your site so that the icon becomes your custom edition.
Now, copy the rest image files (`.PNG` and `.ICO`) to cover the original one in folder `assets/img/favicons/`.
At last, don't forget to rebuild your site so that the icon becomes your custom edition.