This repo supports paulsambolin.com where I write about technology and everything Do It Yourself (DIY). The rest of this readme is from the original website template, my thanks to the original author.
test
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 »
- 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
Follow the Jekyll Docs to complete the installation of Ruby, RubyGems, Jekyll and Bundler.
There are two ways to get the theme:
- Install from RubyGems
- Fork from GitHub
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-chirpyAnd then execute:
$ bundleFinally, copy the extra files (refer to the starter project for the detailed file directory structure) from the theme's gem to your Jekyll site, and append all the variables of the theme's _config.yml to your Jekyll site.
Hint: To locate the theme’s gem, execute:
$ bundle info --path jekyll-theme-chirpyOr you can use the starter template to create a Jekyll site to save time copying contents from theme's gem.
Fork Chirpy from GitHub and clone your fork to local.
Install gem dependencies by:
$ bundleAnd then execute:
$ bash tools/init.shNote: If you don't plan to deploy your site on GitHub Pages, append parameter option
--no-ghat the end of the above command.
What it does is:
-
Remove some files or directories from your repository:
.travis.yml- files under
_posts - folder
docs
-
If you use the
--no-ghoption, the directory.githubwill be deleted. Otherwise, setup the GitHub Action workflow by removing extension.hookof.github/workflows/pages-deploy.yml.hook, and then remove the other files and directories in folder.github. -
Automatically create a commit to save the changes.
Update the variables of _config.yml as needed. Some of them are typical options:
urlavatartimezonetheme_mode
You may want to preview the site contents before publishing, so just run it by:
$ bundle exec jekyll sOr 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.
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.
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 theon.push.branchesshould be the same as your repo's default branch name. - Ensuer your Jekyll site has file
/tools/test.shand/tools/deploy.sh. Otherwise, copy them from this repo to your Jekyll site.
Next, rename your repoistory to <GH-USERNAME>.github.io on GitHub.
And then publish your Jekyll site by:
-
Push any commit to remote to trigger the GitHub Actions workflow. Once the build is complete and successful, a new remote branch named
gh-pageswill appear to store the built site files. -
Browse to your repo's landing page on GitHub and select the branch
gh-pagesas the publishing source throught Settings → Options → GitHub Pages: -
Visit your website at the address indicated by GitHub.
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 bOr 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.
For more details and the better reading experience, please check out the tutorials on demo site. In the meanwhile, a copy of the tutorial is also available on the Wiki.
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.
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).
🎉 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.
Also, thank JetBrains for providing the open source license.
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 the Home Page and choose a link that suits you to donate; this will encourage and help me better maintain the project.
This work is published under MIT License.