web/README.md

Chirpy

Language: English | 简体中文

A minimal, sidebar, responsive web design Jekyll theme that focuses on text presentation. Designed to help you record and share your knowledge easily. Live Demo »

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
• Mermaid diagram & flowchart
• Search
• Atom Feeds
• Disqus Comments
• Google Analytics
• GA Pageviews reporting (Advanced)
• SEO and Performance Optimization

Prerequisites

Follow the Jekyll Docs to complete the installation of Ruby, RubyGems, Jekyll and Bundler.

Installation

There are two ways to get the theme:

• Install from RubyGems - Easy to update, isolate irrelevant project files so you can focus on writing.
• Fork on GitHub - Convenient for custom development, but difficult to update, only suitable for web developers.

Installing the Theme Gem

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-chirpy"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-theme-chirpy

And then execute:

$ bundle

Finally, copy the required files from the theme's gem (for detailed files, see starter project) to your Jekyll site.

Hint: To locate the installed theme’s gem, execute:

$ bundle info --path jekyll-theme-chirpy

Or you can use the starter template to create a Jekyll site to save time copying files from the theme's gem. We have prepared everything for you there!

Fork on GitHub

Fork Chirpy on GitHub and then clone your fork to local. (Please note that the default branch code is in development. If you want the blog to be stable, please switch to the latest tag and start writing.)

Install gem dependencies by:

$ bundle

And then execute:

$ bash tools/init.sh

Note

: If you don't plan to deploy your site 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 the extension .hook of .github/workflows/pages-deploy.yml.hook, and then remove the other files and directories in the folder .github.

3. Automatically create a commit to save the changes.

Usage

Configuration

Update the variables of _config.yml as needed. Some of them are typical options:

• url
• avatar
• timezone
• lang

Running Local Server

You may want to preview the site contents before publishing, so just run it by:

$ bundle exec jekyll s

Or run the site on Docker with the following command:

$ docker run -it --rm \
    --volume="$PWD:/srv/jekyll" \
    -p 4000:4000 jekyll/jekyll \
    jekyll serve

Open a browser and visit to http://localhost:4000.

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 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, e.g, /project-name.

Now you can choose ONE of the following methods to deploy your Jekyll site.

Deploy on GitHub Pages

For security reasons, GitHub Pages build runs on safe mode, which restricts us from using plugins 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 GH Pages service.

Quickly check the files needed for GitHub Actions build:

• Ensure your Jekyll site has the file .github/workflows/pages-deploy.yml. Otherwise, create a new one and fill in the contents of the workflow file, and the value of the on.push.branches should be the same as your repo's default branch name.
• Ensure your Jekyll site has file tools/test.sh and tools/deploy.sh. Otherwise, copy them from this repo to your Jekyll site.

And then rename your repository to <GH-USERNAME>.github.io on GitHub.

Now publish your Jekyll site by:

1. Push any commit to remote to trigger the GitHub Actions workflow. Once the build is complete and successful, a new remote branch named gh-pages will appear to store the built site files.

2. Browse to your repo's landing page on GitHub and select the branch gh-pages as the publishing source through Settings → Options → GitHub Pages:

   

3. Visit your website at the address indicated by GitHub.

Deploy on Other Platforms

On platforms other than GitHub, we cannot enjoy the convenience of GitHub Actions. Therefore, we should build the site locally (or on some other 3rd-party CI platform) and then put the site files on the server.

Go to the root of the source project, build your site by:

$ JEKYLL_ENV=production bundle exec jekyll b

Or build the site with Docker by:

$ docker run -it --rm \
    --env JEKYLL_ENV=production \
    --volume="$PWD:/srv/jekyll" \
    jekyll/jekyll \
    jekyll build

Unless you specified the output path, the generated site files will be placed in folder _site of the project's root directory. Now you should upload those files to your web server.

Documentation

For more details and a better reading experience, please check out the tutorials on the demo site. In the meanwhile, a copy of the tutorial is also available on the 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.

Credits

This theme is mainly built with Jekyll ecosystem, Bootstrap, Font Awesome and some other wonderful tools (their copyright information can be found in the relevant files). The avatar and favicon design comes from Clipart Max.

🎉 Thanks to all the volunteers who contributed to this project, their GitHub IDs are on this list. 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.

Last but not least, thank JetBrains for providing the open source license.

Sponsoring

If you like this theme or find it helpful, please consider sponsoring me, because it will encourage and help me better maintain the project, I will be very grateful!

License

This work is published under MIT License.