Repository files navigation

A Jekyll theme with responsive web design that focuses on text presentation. Hope you like it!Live Demo »

• Last modified date
• Table of Contents
• Disqus Comments
• Syntax highlighting
• Two Level Categories
• Search
• HTML compress
• Atom feeds
• Google Analytics
• Pageviews (Advanced)

Follow theJekyll Docs to complete the installtion of basic environment (Ruby, RubyGem, Bundler and Jekyll). In addition, to use the funny script tools, we also need to installPython(version 3.5 or abover) andruamel.yaml.

Next,forkChirpy and then clone your replicated repository locally.

Go to root directory of the repository and run the following:

$ bundle install

bundle will install all the dependent Jekyll Plugins listed in fileGemfile automatically.

The main files and related brief introductions are listed below.

jekyll-theme-chirpy/├── _data├── _includes      ├── _layouts├── _posts# posts stay here├── _scripts├── assets      ├── tabs│   └── about.md# the ABOUT page├── .gitignore├── .travis.yml# remove it├── 404.html├── Gemfile├── LICENSE├── README.md├── _config.yml# configuration file├── build.sh# script tool├── run.sh# script tool├── init.sh# script tool├── pv.sh           ├── feed.xml├── index.html├── robots.txt├── search.json└── sitemap.xml

Customize the variables in file_config.yml as needed.

The Atom feed url of your site will be:

<SITE_URL>/feed.xml

TheSITE_URL was defined by variableurl in file_config.yml.

You may want to preview the site before publishing, so just run the script tool:

$ bash run.sh

Note: 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.

Open a brower and visithttp://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, ensure theurl in_config.yml has been set tohttps://<username>.github.io.

By deploying your site in this way, you can push the source code to GitHub repository directly.

Note: If you want to add any third-party Jekyll plugins or custom scripts to your project, please refer toOption 2: Build locally.

1. Rename your repository as<username>.github.io.

2. Commit the changes of your repository, then run the initialization script:

$bash init.sh

It will automatically generates theLatest Modified Date andCategories / Tags page for the posts.

3. Push the changes toorigin/master then go to GitHub website and enable GitHub Pages service for the repository<username>.github.io.

4. Visithttps://<username>.github.io and enjoy.

For security reasons, GitHub Pages runs onsafe mode, which means the third-party Jekyll plugins or custom scripts will not work. If you want to use any another third-party Jekyll plugins,your have to build locally rather than on GitHub Pages.

1. On GitHub website, create a brand new repository with name<username>.github.io and then clone it locally.

2. Build your site by:

$bash build.sh -d /path/to/<username>.github.io/

The build results will be stored in the root directory of<username>.github.io and don't forget to push the changes of<username>.github.io to branchmaster on GitHub.

3. Go to GitHub website and enable GitHub Pages service for the new repository<username>.github.io.

4. Visithttps://<username>.github.io and enjoy.

For more information, please see thetutorial. In the meanwhile, a copy of the tutorial is also available on theWiki.

This work is published underMIT License.