Repository files navigation

• Localized Layout
• Configurable Theme Mode
• Pinned Posts
• Hierarchical 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 & Performance Optimization

Follow the instructions in theJekyll Docs to complete the installation ofRuby,RubyGems,Jekyll, andBundler.

There are two ways to create a new repository for this theme:

• Using the Chirpy Starter - Easy to upgrade, isolates irrelevant project files so you can focus on writing.
• Forking on GitHub - Convenient for custom development, but difficult to upgrade. Unless you are familiar with Jekyll and are determined to tweak or contribute to this project, this approach is not recommended.

Create a new repository from theChirpy Starter and name it<GH_USERNAME>.github.io, whereGH_USERNAME represents your GitHub username.

ForkChirpy on GitHub and rename it to<GH_USERNAME>.github.io. Please note that the default branch code is in development. If you want the site to be stable, please switch to thelatest tag and start writing.

And then execute:

$bash tools/init.sh

Note: If you don't want to deploy your site on GitHub Pages, append option--no-gh at the end of the above command.

The above command will:

1. Removes some files or directories from your repository:

   • .travis.yml
   • files under_posts
   • folderdocs

2. If the option--no-gh is provided, the directory.github will be deleted. Otherwise, set up 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. Removes itemGemfile.lock from.gitignore.

4. Creates a new commit to save the changes automatically.

Before running for the first time, go to the root directory of your site, and install dependencies as follows:

$bundle

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

• url
• avatar
• timezone
• lang

If you need to customize the stylesheet, copy the theme'sassets/css/style.scss to the same path on your Jekyll site, and then add the custom style at the end of the style file.

Starting fromv4.1.0, if you want to overwrite the SASS variables defined in_sass/addon/variables.scss, create a new file_sass/variables-hook.scss and assign new values to the target variable in it.

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

$bundleexec 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

After a while, the local service will be published athttp://127.0.0.1:4000.

Before the deployment begins, check out the file_config.yml and make sure theurl is configured correctly. Furthermore, if you prefer theproject site and don't use a custom domain, or you want to visit your website with a base URL on a web server other thanGitHub Pages, remember to change thebaseurl to your project name that starts with a slash, e.g,/project-name.

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

For security reasons, GitHub Pages build runs onsafe mode, which restricts us from using plugins to generate additional page files. Therefore, we can useGitHub Actions to build the site, store the built site files on a new branch, and use that branch as the source of the GitHub 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 thesample file, and the value of theon.push.branches should be the same as your repo's default branch name.

• Ensure your Jekyll site has filetools/deploy.sh. Otherwise, copy it from here to your Jekyll site.

• Furthermore, if you have committedGemfile.lock to the repo, and your runtime system is not Linux, don't forget to update the platform list in the lock file:

  $bundle lock --add-platform x86_64-linux

After the above steps, 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 namedgh-pages will appear to store the built site files.

2. Browse to your repository on GitHub. Select the tabSettings, then clickPages in the left navigation bar, and then in the sectionSource ofGitHub Pages, select the/(root) directory of branchgh-pages as thepublishing source. Remember to clickSave before leaving.

   

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

On self-hosted servers, you cannot enjoy the convenience ofGitHub Actions. Therefore, you should build the site on your local machine and then upload the site files to the server.

Go to the root of the source project, and build your site as follows:

$JEKYLL_ENV=production bundleexec jekyll b

Or build the site on Docker:

$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 the target server.

It depends on how you use the theme:

• If you are using the theme gem (there will begem "jekyll-theme-chirpy" in theGemfile), editing theGemfile and update the version number of the theme gem, for example:

  - gem "jekyll-theme-chirpy", "~> 3.2", ">= 3.2.1"+ gem "jekyll-theme-chirpy", "~> 3.3", ">= 3.3.0"

  And then execute the following command:

  $bundle update jekyll-theme-chirpy

  As the version upgrades, the critical files (for details, see theStartup Template) and configuration options will change. Please refer to theUpgrade Guide to keep your repo's files in sync with the latest version of the theme.

• If you forked from the source project (there will begemspec in theGemfile of your site), then merge thelatest upstream tags into your Jekyll site to complete the upgrade.The merge is likely to conflict with your local modifications. Please be patient and careful to resolve these conflicts.

For more details and a better reading experience, please check out thetutorials on the demo site. In the meanwhile, a copy of the tutorial is also available on theWiki. Please note that the tutorials on the demo website or Wiki are based on the latest release, and the features ofmaster branch are usually ahead of the documentation.

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, seecontributing guidelines.

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

🎉 Thanks to all the volunteers who contributed to this project, their GitHub IDs are onthis 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, thankJetBrains for providing the open source license.

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!

This work is published underMIT License.