web/README.md

107 lines
4.7 KiB
Markdown
Raw Normal View History

2021-07-19 17:24:04 +03:00
<div align="center">
2021-09-29 15:44:17 +03:00
# Chirpy Jekyll Theme
2021-11-26 18:29:51 +03:00
A minimal, responsive, and powerful Jekyll theme for presenting professional writing.
2021-09-29 15:44:17 +03:00
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)](https://rubygems.org/gems/jekyll-theme-chirpy)
2022-10-22 11:52:54 +03:00
[![CI](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml/badge.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml)
2021-10-25 22:55:00 +03:00
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894)](https://www.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=cotes2020/jekyll-theme-chirpy&amp;utm_campaign=Badge_Grade)
2021-09-29 15:44:17 +03:00
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)
[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)
2021-07-19 17:24:04 +03:00
[**Live Demo →**](https://cotes2020.github.io/chirpy-demo)
2021-09-29 15:44:17 +03:00
2022-12-04 22:50:51 +03:00
[![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)](https://cotes2020.github.io/chirpy-demo)
2021-09-29 15:44:17 +03:00
</div>
2020-04-12 19:38:56 +03:00
## Features
2019-09-30 15:37:14 +03:00
2022-01-04 00:12:48 +03:00
- Dark/Light Theme Mode
2022-12-27 20:24:55 +03:00
- Localized UI language
- Pinned Posts
2021-07-19 17:24:04 +03:00
- Hierarchical Categories
2022-12-27 20:24:55 +03:00
- Trending Tags
- Table of Contents
2022-12-27 20:24:55 +03:00
- Last Modified Date of Posts
2021-07-19 17:24:04 +03:00
- Syntax Highlighting
- Mathematical Expressions
- Mermaid Diagram & Flowchart
2022-12-27 20:24:55 +03:00
- Dark/Light Mode Images
- Embed Videos
2022-02-12 01:06:42 +03:00
- Disqus/Utterances/Giscus Comments
- Search
- Atom Feeds
- Google Analytics
2022-12-27 20:24:55 +03:00
- Page Views Reporting
2021-07-19 17:24:04 +03:00
- SEO & Performance Optimization
2019-09-30 15:37:14 +03:00
2022-01-04 00:12:48 +03:00
## Quick Start
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.
2021-07-19 17:24:04 +03:00
2022-01-04 00:12:48 +03:00
### Step 1. Creating a New Site
2021-10-25 20:16:50 +03:00
2022-01-04 00:12:48 +03:00
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.
2021-07-19 17:24:04 +03:00
2022-01-04 00:12:48 +03:00
### Step 2. Installing Dependencies
2021-01-25 15:19:50 +03:00
Before running for the first time, go to the root directory of your site, and install dependencies as follows:
2021-01-25 15:19:50 +03:00
```console
$ bundle
```
2022-01-04 00:12:48 +03:00
### Step 3. Running Local Server
2021-07-19 17:24:04 +03:00
2022-01-04 00:12:48 +03:00
Run the following command in the root directory of the site:
2019-11-16 18:12:26 +03:00
2021-01-25 15:19:50 +03:00
```console
2020-11-19 16:32:50 +03:00
$ bundle exec jekyll s
2019-09-30 15:37:14 +03:00
```
2019-11-16 18:12:26 +03:00
2022-01-04 00:12:48 +03:00
Or run with Docker:
2021-09-29 15:44:00 +03:00
```console
2020-11-19 16:32:50 +03:00
$ docker run -it --rm \
--volume="$PWD:/srv/jekyll" \
-p 4000:4000 jekyll/jekyll \
2020-11-19 16:32:50 +03:00
jekyll serve
```
2022-01-07 11:12:50 +03:00
After a while, navigate to the site at <http://localhost:4000>.
2021-01-25 15:19:50 +03:00
## Documentation
2022-09-10 12:33:38 +03:00
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 release](https://github.com/cotes2020/jekyll-theme-chirpy/releases/latest), and the features of the default branch are usually ahead of the documentation.
## Contributing
2022-01-04 00:12:48 +03:00
Welcome to report bugs, improve code quality or submit a new feature. For more information, see [contributing guidelines](.github/CONTRIBUTING.md).
## Credits
2019-09-30 15:37:14 +03:00
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/).
2019-11-05 17:14:02 +03:00
2022-01-07 11:12:50 +03:00
: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.
2020-01-04 12:05:41 +03:00
2022-01-07 11:12:50 +03:00
Last but not least, thank [JetBrains][jb] for providing the OSS development license.
2021-01-25 15:19:50 +03:00
## Sponsoring
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!
2020-01-04 12:05:41 +03:00
[![Ko-fi](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ff5f5f?logo=ko-fi&logoColor=white)](https://ko-fi.com/coteschung)
2021-02-26 15:47:19 +03:00
[![Wechat Pay](https://img.shields.io/badge/-Tip%20Me%20on%20WeChat-brightgreen?logo=wechat&logoColor=white)][cn-donation]
[![Alipay](https://img.shields.io/badge/-Tip%20Me%20on%20Alipay-blue?logo=alipay&logoColor=white)][cn-donation]
2019-09-30 15:37:14 +03:00
## License
2020-09-16 20:36:38 +03:00
This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License.
<!-- ReadMe links -->
[jb]: https://www.jetbrains.com/?from=jekyll-theme-chirpy
2022-11-22 01:03:41 +03:00
[cn-donation]: https://sponsor.cotes.page/