{"id":20415978,"url":"https://github.com/finb/finb.github.com","last_synced_at":"2026-03-19T15:43:25.972Z","repository":{"id":49451281,"uuid":"46105926","full_name":"Finb/finb.github.com","owner":"Finb","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-04T07:37:39.000Z","size":941,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-05T03:41:40.861Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Finb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-13T07:08:34.000Z","updated_at":"2022-11-04T20:43:36.000Z","dependencies_parsed_at":"2023-02-02T03:31:27.257Z","dependency_job_id":null,"html_url":"https://github.com/Finb/finb.github.com","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Finb/finb.github.com","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finb%2Ffinb.github.com","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finb%2Ffinb.github.com/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finb%2Ffinb.github.com/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finb%2Ffinb.github.com/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Finb","download_url":"https://codeload.github.com/Finb/finb.github.com/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finb%2Ffinb.github.com/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30324185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T01:36:58.598Z","status":"online","status_checked_at":"2026-03-10T02:00:06.579Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T06:18:16.107Z","updated_at":"2026-03-10T04:04:27.029Z","avatar_url":"https://github.com/Finb.png","language":"SCSS","funding_links":["https://www.buymeacoffee.com/coteschung"],"categories":[],"sub_categories":[],"readme":"# Chirpy\n\nLanguage: English | [简体中文](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/README.zh-CN.md)\n\n[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)](https://rubygems.org/gems/jekyll-theme-chirpy)\n[![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master\u0026event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8220b926db514f13afc3f02b7f884f4b)](https://app.codacy.com/manual/cotes2020/jekyll-theme-chirpy?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=cotes2020/jekyll-theme-chirpy\u0026utm_campaign=Badge_Grade_Dashboard)\n[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)\n[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)\n\nA minimal, sidebar, responsive web design Jekyll theme that focuses on text presentation. Designed to help you record and share your knowledge easily. [Live Demo »](https://chirpy.cotes.info)\n\n[![Devices Mockup](https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/commons/devices-mockup.png)](https://chirpy.cotes.info)\n\n## Features\n\n- Pinned Posts\n- Configurable theme mode\n- Double-level Categories\n- Last modified date for posts\n- Table of Contents\n- Automatically recommend related posts\n- Syntax highlighting\n- Mathematical expressions\n- Mermaid diagram \u0026 flowchart\n- Search\n- Atom Feeds\n- Disqus Comments\n- Google Analytics\n- GA Pageviews reporting (Advanced)\n- SEO and Performance Optimization\n\n## Prerequisites\n\nFollow the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.\n\n## Installation\n\nThere are two ways to get the theme:\n\n- **Install from RubyGems** - Easy to update, isolate irrelevant project files so you can focus on writing.\n- **Fork on GitHub** - Convenient for custom development, but difficult to update, only suitable for web developers.\n\n### Installing the Theme Gem\n\nAdd this line to your Jekyll site's `Gemfile`:\n\n```ruby\ngem \"jekyll-theme-chirpy\"\n```\n\nAnd add this line to your Jekyll site's `_config.yml`:\n\n```yaml\ntheme: jekyll-theme-chirpy\n```\n\nAnd then execute:\n\n```console\n$ bundle\n```\n\nFinally, copy the required files from the theme's gem (for detailed files, see [starter project][starter]) to your Jekyll site.\n\n\u003e **Hint**: To locate the installed theme’s gem, execute:\n\u003e\n\u003e ```console\n\u003e $ bundle info --path jekyll-theme-chirpy\n\u003e ```\n\nOr you can [**use the starter template**][use-starter] to create a Jekyll site to save time copying files from the theme's gem. We have prepared everything for you there!\n\n### Fork on GitHub\n\n[Fork **Chirpy**](https://github.com/cotes2020/jekyll-theme-chirpy/fork) 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](https://github.com/cotes2020/jekyll-theme-chirpy/tags) and start writing.)\n\nInstall gem dependencies by:\n\n```console\n$ bundle\n```\n\nAnd then execute:\n\n```console\n$ bash tools/init.sh\n```\n\n\u003e **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.\n\nWhat it does is:\n\n1. Remove some files or directories from your repository:\n    - `.travis.yml`\n    - files under `_posts`\n    - folder `docs`\n\n2. 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`.\n\n3. Automatically create a commit to save the changes.\n\n## Usage\n\n### Configuration\n\nUpdate the variables of `_config.yml` as needed. Some of them are typical options:\n\n- `url`\n- `avatar`\n- `timezone`\n- `lang`\n\n### Running Local Server\n\nYou may want to preview the site contents before publishing, so just run it by:\n\n```console\n$ bundle exec jekyll s\n```\n\nOr run the site on Docker with the following command:\n\n```terminal\n$ docker run -it --rm \\\n    --volume=\"$PWD:/srv/jekyll\" \\\n    -p 4000:4000 jekyll/jekyll \\\n    jekyll serve\n```\n\nOpen a browser and visit to _\u003chttp://localhost:4000\u003e_.\n\n### Deployment\n\nBefore the deployment begins, checkout the file `_config.yml` and make sure the `url` is configured correctly. Furthermore, if you prefer the [**project site**](https://help.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites) 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`.\n\nNow you can choose ONE of the following methods to deploy your Jekyll site.\n\n#### Deploy on GitHub Pages\n\nFor 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.\n\nQuickly check the files needed for GitHub Actions build:\n\n- 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][workflow], and the value of the `on.push.branches` should be the same as your repo's default branch name.\n- Ensure your Jekyll site has file `tools/test.sh` and `tools/deploy.sh`. Otherwise, copy them from this repo to your Jekyll site.\n\nAnd then rename your repository to `\u003cGH-USERNAME\u003e.github.io` on GitHub.\n\nNow publish your Jekyll site by:\n\n1. 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.\n\n2. Browse to your repo's landing page on GitHub and select the branch `gh-pages` as the [publishing source](https://docs.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) through _Settings_ → _Options_ → _GitHub Pages_:\n\n    ![gh-pages-sources](https://cdn.jsdelivr.net/gh/cotes2020/chirpy-images/posts/20190809/gh-pages-sources.png)\n\n3. Visit your website at the address indicated by GitHub.\n\n#### Deploy on Other Platforms\n\nOn 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.\n\nGo to the root of the source project, build your site by:\n\n```console\n$ JEKYLL_ENV=production bundle exec jekyll b\n```\n\nOr build the site with Docker by:\n\n```terminal\n$ docker run -it --rm \\\n    --env JEKYLL_ENV=production \\\n    --volume=\"$PWD:/srv/jekyll\" \\\n    jekyll/jekyll \\\n    jekyll build\n```\n\nUnless 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.\n\n## Documentation\n\nFor more details and a better reading experience, please check out the [tutorials on the demo site](https://chirpy.cotes.info/categories/tutorial/). In the meanwhile, a copy of the tutorial is also available on the [Wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki).\n\n## Contributing\n\nThe 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](.github/CONTRIBUTING.md).\n\n## Credits\n\nThis theme is mainly built with [Jekyll](https://jekyllrb.com/) ecosystem, [Bootstrap](https://getbootstrap.com/), [Font Awesome](https://fontawesome.com/) and some other wonderful tools (their copyright information can be found in the relevant files). The avatar and favicon design comes from [Clipart Max](https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/).\n\n:tada: Thanks to all the volunteers who contributed to this project, their GitHub IDs are on [this list](https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors). 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.\n\nLast but not least, thank [JetBrains][jb] for providing the open source license.\n\n## Sponsoring\n\nIf 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!\n\n[![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ff813f?logo=buy-me-a-coffee\u0026logoColor=white)](https://www.buymeacoffee.com/coteschung)\n[![Wechat Pay](https://img.shields.io/badge/-Tip%20Me%20on%20WeChat-brightgreen?logo=wechat\u0026logoColor=white)][cn-donation]\n[![Alipay](https://img.shields.io/badge/-Tip%20Me%20on%20Alipay-blue?logo=alipay\u0026logoColor=white)][cn-donation]\n\n## License\n\nThis work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License.\n\n[starter]: https://github.com/cotes2020/chirpy-starter\n[use-starter]: https://github.com/cotes2020/chirpy-starter/generate\n[workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook\n\n\u003c!-- ReadMe links --\u003e\n\n[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy\n[cn-donation]: https://cotes.gitee.io/alipay-wechat-donation/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinb%2Ffinb.github.com","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinb%2Ffinb.github.com","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinb%2Ffinb.github.com/lists"}