Skip to content

Commit b04b345

Browse files
committed
Import README.
1 parent 8838573 commit b04b345

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Jekyll Theme Chirpy
2+
3+
[![Build Status](https://travis-ci.com/cotes2020/jekyll-theme-chirpy.svg?branch=master)](https://travis-ci.com/cotes2020/jekyll-theme-chirpy)
4+
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)
5+
[![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)
6+
7+
![devices-mockup](assets/img/sample/devices-mockup.png)
8+
9+
A Jekyll theme with responsive web design that focuses on text presentation. [Live Demo »](https://chirpy.cotes.info)
10+
11+
## Features
12+
13+
* Last modified date
14+
* Table of Contents
15+
* Disqus Comments
16+
* Syntax highlighting
17+
* Two Level Categories
18+
* Search
19+
* HTML compress
20+
* Atom feeds
21+
* Google Analytics
22+
* Pageviews (Advanced)
23+
24+
## Quick start
25+
26+
First of all, complete the installation of the following environment dependencies:
27+
28+
- [Ruby](https://www.ruby-lang.org/en/downloads/)
29+
- [RubyGem](https://rubygems.org/pages/download)
30+
- [Bundler](https://bundler.io/)
31+
- [Jekyll](https://jekyllrb.com/)
32+
- [Python](https://www.python.org/downloads/)
33+
- [ruamel.yaml](https://pypi.org/project/ruamel.yaml/)
34+
35+
Clone the repository locally, but to prevent losing the latest features, consider using **Fork** instead of cloning.
36+
37+
Install the Jekyll plugins:
38+
39+
```
40+
$ bundle install
41+
```
42+
43+
Boot your site locally:
44+
45+
```
46+
$ bash run.sh
47+
```
48+
49+
Now, open your favorite brower and visit <http://127.0.0.1:4000>
50+
51+
Please refer to the [documentation](https://chirpy.cotes.info/posts/getting-started/) for more details. Hope you like it.
52+
53+
54+
## License
55+
56+
This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License.

0 commit comments

Comments
 (0)