# Chirpy 🌏 English • [简体中文](docs/README_zh-CN.md) [![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) [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) 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) [![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) ## Features * 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 ## Installation [Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) on GitHub, and clone the fork to local by: ```terminal $ git clone git@github.com:/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`. 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`. What's more, in order to generate some extra files (*categories*, *tags* and *last modified list*), we need to use some tool scripts. If your machine is running Debian or macOS, make sure that [GNU coreutils](https://www.gnu.org/software/coreutils/) is installed. Otherwise, install by: * Debian ```console $ sudo apt-get install coreutils ``` * macOS ```console $ brew install coreutils ``` ## Usage 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. ### Initialization Go to the root directory of the project and start initialization: ```console $ bash tools/init.sh ``` > If you not intend to deploy it on GitHub Pages, append parameter option `--no-gh` at the end of the above command. What it does is: 1. Remove some files or directories from your repository: * `.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`. 3. Automatically create a commit to save the changes. ### Configuration Generally, go to `_config.yml` and configure the variables as needed. Some of them are typical options: * `url` * `avatar` * `timezone` * `theme_mode` ### Run Locally You may want to preview the site contents before publishing, so just run it by: ```terminal $ bash tools/run.sh ``` Then open a browser and visit to . 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 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`. Assuming you have already gone through the [initialization](#initialization), you can now choose any of the following methods to deploy your website. #### Deploy on GitHub Pages 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. 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 `.github.io` on GitHub. 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. 4. Visit your website at the address indicated by GitHub. #### 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: ```console $ bash tools/publish.sh ``` > 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. 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: ```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! ``` Lastly, enable the pages service according to the instructions of the platform you choose. #### Deploy on Private Server In the root of the source project, build your site by: ```console $ bash tools/build.sh -d /path/to/site/ ``` 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. ### Documentation 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 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 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). :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. ## Support If you enjoy this theme or find it helpful, please consider becoming my sponsor, I'd really appreciate it! Click the button :heart: Sponsor 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. ## License This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License.