|
| 1 | +<div align="center"> |
| 2 | + |
| 3 | + # Chirpy Jekyll Theme |
| 4 | + |
| 5 | + A minimal, responsive, and powerful Jekyll theme for presenting professional writing. |
| 6 | + |
| 7 | + [](https://rubygems.org/gems/jekyll-theme-chirpy) |
| 8 | + [](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush) |
| 9 | + [](https://www.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cotes2020/jekyll-theme-chirpy&utm_campaign=Badge_Grade) |
| 10 | + [](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) |
| 11 | + [](https://996.icu) |
| 12 | + |
| 13 | + [**Live Demo →**](https://cotes2020.github.io/chirpy-demo) |
| 14 | + |
| 15 | + [](https://cotes2020.github.io/chirpy-demo) |
| 16 | + |
| 17 | +</div> |
| 18 | + |
| 19 | +## Features |
| 20 | + |
| 21 | +- Localized Layout |
| 22 | +- Dark/Light Theme Mode |
| 23 | +- Pinned Posts |
| 24 | +- Hierarchical Categories |
| 25 | +- Last Modified Date for Posts |
| 26 | +- Table of Contents |
| 27 | +- Auto-generated Related Posts |
| 28 | +- Syntax Highlighting |
| 29 | +- Mathematical Expressions |
| 30 | +- Mermaid Diagram & Flowchart |
| 31 | +- Disqus/Utterances/Giscus Comments |
| 32 | +- Search |
| 33 | +- Atom Feeds |
| 34 | +- Google Analytics |
| 35 | +- GA Pageviews Reporting |
| 36 | +- SEO & Performance Optimization |
| 37 | + |
| 38 | + |
| 39 | +## Quick Start |
| 40 | + |
| 41 | +Before starting, please follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll`, and `Bundler`. In addition, [Git](https://git-scm.com/) is also required to be installed. |
| 42 | + |
| 43 | +### Step 1. Creating a New Site |
| 44 | + |
| 45 | +Create a new repository from the [**Chirpy Starter**](https://github.com/cotes2020/chirpy-starter/generate) and name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username. |
| 46 | + |
| 47 | +### Step 2. Installing Dependencies |
| 48 | + |
| 49 | +Before running for the first time, go to the root directory of your site, and install dependencies as follows: |
| 50 | + |
| 51 | +```console |
| 52 | +$ bundle |
| 53 | +``` |
| 54 | + |
| 55 | +### Step 3. Running Local Server |
| 56 | + |
| 57 | +Run the following command in the root directory of the site: |
| 58 | + |
| 59 | +```console |
| 60 | +$ bundle exec jekyll s |
| 61 | +``` |
| 62 | + |
| 63 | +Or run with Docker: |
| 64 | + |
| 65 | +```console |
| 66 | +$ docker run -it --rm \ |
| 67 | + --volume="$PWD:/srv/jekyll" \ |
| 68 | + -p 4000:4000 jekyll/jekyll \ |
| 69 | + jekyll serve |
| 70 | +``` |
| 71 | + |
| 72 | +After a while, navigate to the site at <http://localhost:4000>. |
| 73 | + |
| 74 | +## Documentation |
| 75 | + |
| 76 | +For more details on usage, please refer to the tutorial on the [demo website](https://cotes2020.github.io/chirpy-demo/) / [wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). Note that the tutorial is based on the [latest tag](https://github.com/cotes2020/jekyll-theme-chirpy/tags), and the features of the default branch are usually ahead of the documentation. |
| 77 | + |
| 78 | +## Contributing |
| 79 | + |
| 80 | +Welcome to report bugs, improve code quality or submit a new feature. For more information, see [contributing guidelines](.github/CONTRIBUTING.md). |
| 81 | + |
| 82 | +## Credits |
| 83 | + |
| 84 | +This 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 come from [Clipart Max](https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/). |
| 85 | + |
| 86 | +: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. |
| 87 | + |
| 88 | +Last but not least, thank [JetBrains][jb] for providing the OSS development license. |
| 89 | + |
| 90 | +## Sponsoring |
| 91 | + |
| 92 | +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! |
| 93 | + |
| 94 | +[](https://ko-fi.com/coteschung) |
| 95 | +[][cn-donation] |
| 96 | +[][cn-donation] |
| 97 | + |
| 98 | +## License |
| 99 | + |
| 100 | +This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License. |
| 101 | + |
| 102 | +<!-- ReadMe links --> |
| 103 | + |
| 104 | +[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy |
| 105 | +[cn-donation]: https://cotes.gitee.io/alipay-wechat-donation/ |
0 commit comments