web/README.md

191 lines
8.7 KiB
Markdown
Raw Normal View History

2020-04-05 14:01:34 +03:00
# Chirpy
2020-04-12 19:38:56 +03:00
🌏 English • [简体中文](docs/README_zh-CN.md)
2019-09-30 15:37:14 +03:00
[![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush)
2020-08-19 21:08:07 +03:00
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade_Dashboard)
2019-09-30 15:37:14 +03:00
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)
2020-01-04 12:05:41 +03:00
[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)
2020-04-12 19:38:56 +03:00
A minimal, sidebar, responsive web design Jekyll theme, focusing on text presentation, aim to help you easily record and share your knowledge. [Live Demo »](https://chirpy.cotes.info)
2019-09-30 15:37:14 +03:00
2020-04-12 19:38:56 +03:00
[![Devices Mockup](https://raw.githubusercontent.com/cotes2020/jekyll-theme-chirpy/master/assets/img/sample/devices-mockup.png)](https://chirpy.cotes.info)
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Credits](#credits)
- [Support](#support)
- [License](#license)
2020-04-12 19:38:56 +03:00
## Features
2019-09-30 15:37:14 +03:00
- Pinned Posts
- Configurable theme mode
- Double-level Categories
- Last modified date for posts
- Table of Contents
- Automatically recommend related posts
- Syntax highlighting
- Mathematical expressions
- Search
- Atom Feeds
- Disqus Comments
- Google Analytics
- GA Pageviews reporting (Advanced)
- SEO and Performance Optimization
2019-09-30 15:37:14 +03:00
2020-08-02 21:25:40 +03:00
## Installation
2019-09-30 15:37:14 +03:00
2020-08-02 21:25:40 +03:00
[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub, and clone the fork to local by:
2019-09-30 15:37:14 +03:00
2020-08-02 21:25:40 +03:00
```terminal
$ git clone git@github.com:<username>/jekyll-theme-chirpy -b master --single-branch
```
### Setting up the local envrionment
If you would like to run or build the project on your local machine, please follow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems` and `Bundler`.
2020-08-02 21:25:40 +03:00
Before running or building for the first time, please complete the installation of the Jekyll plugins. Go to the root directory of project and run:
```terminal
$ bundle install
```
`bundle` will automatically install all the dependencies specified by `Gemfile`.
2020-09-16 20:36:38 +03:00
In order to generate some extra files (*categories*, *tags* and *last modified list*), we need to use some tool scripts. And they require dependency package [yq](https://github.com/mikefarah/yq#install) to be installed. What's more, if your machine is running Debian or macOS, you also need to install [GNU coreutils](https://www.gnu.org/software/coreutils/):
2019-11-16 18:12:26 +03:00
- Debian
2019-11-16 18:12:26 +03:00
2020-07-08 23:52:03 +03:00
```console
$ sudo apt-get install coreutils
```
- macOS
2020-07-08 23:52:03 +03:00
```console
$ brew install coreutils
```
2020-08-02 21:25:40 +03:00
## Usage
2020-08-02 21:25:40 +03:00
Running [**Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/) requires some extra files, which cannot be generated by Jekyll native commands, so please strictly follow the methods mentioned below to run or deploy your website.
2020-08-02 21:25:40 +03:00
### Initialization
2020-08-02 21:25:40 +03:00
Go to the root directory of the project and start initialization:
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
```console
$ bash tools/init.sh
2019-09-30 15:37:14 +03:00
```
2020-08-02 21:25:40 +03:00
> If you not intend to deploy it on GitHub Pages, append parameter option `--no-gh` at the end of the above command.
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
What it does is:
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
1. Remove some files or directories from your repository:
2020-01-04 12:05:41 +03:00
- `.travis.yml`
- files under `_posts`
- folder `docs`
2. If you use the `--no-gh` option, the directory `.github` will be deleted. Otherwise, setup the GitHub Action workflow by removing extension `.hook` of `.github/workflows/pages-deploy.yml.hook`, and then remove the other files and directories in folder `.github`.
2020-01-04 12:05:41 +03:00
2020-08-02 21:25:40 +03:00
3. Automatically create a commit to save the changes.
2020-01-04 12:05:41 +03:00
2020-04-12 19:38:56 +03:00
### Configuration
2019-11-16 18:12:26 +03:00
2020-04-12 19:38:56 +03:00
Generally, go to `_config.yml` and configure the variables as needed. Some of them are typical options:
2020-08-19 20:11:56 +03:00
- `url`
- `avatar`
- `timezone`
- `theme_mode`
2020-03-02 00:15:49 +03:00
2020-08-02 21:25:40 +03:00
### Run Locally
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
You may want to preview the site contents before publishing, so just run it by:
2019-11-16 18:12:26 +03:00
```terminal
2020-01-01 20:21:43 +03:00
$ bash tools/run.sh
2019-09-30 15:37:14 +03:00
```
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
Then open a browser and visit to <http://localhost:4000>.
Few days later, you may find that the file changes does not refresh in real time by using `run.sh`. Don't worry, the advanced option `-r` (or `--realtime`) will solve this problem, but it requires [**fswatch**](http://emcrisostomo.github.io/fswatch/) to be installed on your machine.
### Deployment
2019-11-18 17:36:22 +03:00
2020-08-19 20:11:56 +03:00
Before the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [*project site*](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) and don't use a custom domain, or you want to visit your website with a base url on a web server other than **GitHub Pages**, remember to change the `baseurl` to your project name that starting with a slash. For example, `/project`.
2019-11-18 17:36:22 +03:00
2020-08-02 21:25:40 +03:00
Assuming you have already gone through the [initialization](#initialization), you can now choose any of the following methods to deploy your website.
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
#### Deploy on GitHub Pages
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
For security reasons, GitHub Pages build runs on `safe` mode, which restricts us from using tool scripts to generate additional page files. Therefore, we can use GitHub Actions to build the site, store the built site files on a new branch, and use that branch as the source of the Pages service.
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
1. Push any commit to `origin/master` to trigger the GitHub Actions workflow. Once the build is complete, a new remote branch called `gh-pages` will appear, which is used to store the built site files.
2. Unless you prefer to project sites, rename your repository to `<username>.github.io` on GitHub.
2020-08-10 19:36:22 +03:00
3. Choose branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) for your GitHub Pages site.
2020-08-02 21:25:40 +03:00
4. Visit your website at the address indicated by GitHub.
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
#### Deploy on Other Platforms
On platforms other than GitHub, e.g. GitLab, we cannot enjoy the convenience of **GitHub Actions**. However, we have a tool to make up for this shortcoming.
Commit the changes of your repository first, then run the publish script:
2019-11-16 18:12:26 +03:00
```console
$ bash tools/publish.sh
2019-11-16 18:12:26 +03:00
```
> Please note that the *Recent Update* list requires the latest git-log date of posts, thus make sure the changes in `_posts` have been committed before running this command.
2020-08-02 21:25:40 +03:00
It will automatically generates the *Latest Modified Date* and *Categories / Tags* page for the posts and submit a commit, then push to `origin/master`. Its output is similar to the following log:
2020-03-02 00:15:49 +03:00
```terminal
[INFO] Success to update lastmod for 4 post(s).
[INFO] Succeed! 3 category-pages created.
[INFO] Succeed! 4 tag-pages created.
[INFO] Published successfully!
2020-03-02 00:15:49 +03:00
```
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
Lastly, enable the pages service according to the instructions of the platform you choose.
2020-01-04 12:05:41 +03:00
2020-08-02 21:25:40 +03:00
#### Deploy on Private Server
2019-11-16 18:12:26 +03:00
2020-08-02 21:25:40 +03:00
In the root of the source project, build your site by:
2019-11-16 18:12:26 +03:00
```console
2020-08-02 21:25:40 +03:00
$ bash tools/build.sh -d /path/to/site/
2019-11-16 18:12:26 +03:00
```
2020-08-02 21:25:40 +03:00
The generated site files will be placed in the root of `/path/to/site/`. Now you should upload those files to your web server, such as Nginx.
2019-09-30 15:37:14 +03:00
### Documentation
2020-08-02 21:25:40 +03:00
For more details and the better reading experience, please check out the [tutorials on demo site](https://chirpy.cotes.info/categories/tutorial/). In the meanwhile, a copy of the tutorial is also available on the [Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki).
## Contributing
2020-04-05 14:01:34 +03:00
The old saying, "Two heads are better than one." Consequently, welcome to report bugs, improve code quality or submit a new feature. For more information, see [contributing guidelines](.github/CONTRIBUTING.md).
## Credits
2019-09-30 15:37:14 +03:00
2020-08-02 21:25:40 +03:00
This theme is mainly built with [Jekyll](https://jekyllrb.com/) ecosystem, [Bootstrap](https://getbootstrap.com/), [Font Awesome](https://fontawesome.com/) and some other wonderful tools (their copyright information can be found in the relevant files).
2019-11-05 17:14:02 +03:00
2020-08-02 21:25:40 +03:00
:tada: Thanks to all the volunteers who contributed to this project, their GitHub IDs are on [this list](https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors). Also, I won't forget those guys who submitted the issues or unmerged PR because they reported bugs, shared ideas or inspired me to write more readable documentation.
2020-01-04 12:05:41 +03:00
## Support
2020-01-04 12:05:41 +03:00
2020-08-02 21:25:40 +03:00
If you enjoy this theme or find it helpful, please consider becoming my sponsor, I'd really appreciate it! Click the button <kbd>:heart: Sponsor</kbd> at the top of the [Home Page](https://github.com/cotes2020/jekyll-theme-chirpy) and choose a link that suits you to donate; this will encourage and help me better maintain the project.
2019-09-30 15:37:14 +03:00
## License
2020-09-16 20:36:38 +03:00
This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License.