Repository files navigation

🌏 English •简体中文

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

• Features
• Installation
• Usage
• Contributing
• Credits
• Support
• License

• 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

ForkChirpy on GitHub, and clone the fork to local by:

$ git clone git@github.com:<username>/jekyll-theme-chirpy -b master --single-branch

If you would like to run or build the project on your local machine, please follow theJekyll Docs to complete the installation ofRuby,RubyGems andBundler.

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:

$ bundle install

bundle will automatically install all the dependencies specified byGemfile.

In order to generate some extra files (categories,tags andlast modified list), we need to use some tool scripts. And they require dependency packageyq to be installed. What's more, if your machine is running Debian or macOS, you also need to installGNU coreutils:

• Debian

  $sudo apt-get install coreutils

• macOS

  $brew install coreutils

RunningChirpy 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.

Go to the root directory of the project and start initialization:

$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
   • folderdocs

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.

Generally, go to_config.yml and configure the variables as needed. Some of them are typical options:

• url
• avatar
• timezone
• theme_mode

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

$ bash tools/run.sh

Then open a browser and visit tohttp://localhost:4000.

Few days later, you may find that the file changes does not refresh in real time by usingrun.sh. Don't worry, the advanced option-r (or--realtime) will solve this problem, but it requiresfswatch to be installed on your machine.

Before the deployment begins, checkout 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 starting with a slash. For example,/project.

Assuming you have already gone through theinitialization, you can now choose any of the following methods to deploy your website.

For security reasons, GitHub Pages build runs onsafe 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 toorigin/master to trigger the GitHub Actions workflow. Once the build is complete, a new remote branch calledgh-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.
3. Choose branchgh-pages as thepublishing source for your GitHub Pages site.
4. Visit your website at the address indicated by GitHub.

On platforms other than GitHub, e.g. GitLab, we cannot enjoy the convenience ofGitHub Actions. However, we have a tool to make up for this shortcoming.

Commit the changes of your repository first, then run the publish script:

$bash tools/publish.sh

Please note that theRecent 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 theLatest Modified Date andCategories / Tags page for the posts and submit a commit, then push toorigin/master. Its output is similar to the following log:

[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.

In the root of the source project, build your site by:

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

For more details and the better reading experience, please check out thetutorials on demo site. In the meanwhile, a copy of the tutorial is also available on theWiki.

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).

🎉 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.

If you enjoy this theme or find it helpful, please consider becoming my sponsor, I'd really appreciate it! Click the button❤️ Sponsor at the top of theHome Page and choose a link that suits you to donate; this will encourage and help me better maintain the project.

This work is published underMIT License.