Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zhengtianbao committed Mar 14, 2024
1 parent 0fe137a commit 8d54bd2
Showing 1 changed file with 47 additions and 60 deletions.
107 changes: 47 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,68 @@
<div align="center">
Zhengtianbao's Blog
===================

# Chirpy Jekyll Theme
## 本地运行环境配置

A minimal, responsive, and feature-rich Jekyll theme for technical writing.
### 1. 安装 ruby

[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)][gem]&nbsp;
[![CI](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml/badge.svg?branch=master&event=push)][ci]&nbsp;
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894)][codacy]&nbsp;
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)][license]&nbsp;
[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)
注意:

[**Live Demo**][demo]
- ubuntu 20.04 环境下用 apt 直接安装的 ruby 版本过低,需要通过 Rbenv 管理工具安装高版本
- 不要使用 zsh,用 bash 环境安装运行

[![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo]
安装依赖

</div>
```
sudo apt-get install ruby-full build-essential zlib1g-dev
```

## Features
安装 Rbenv

- Dark / Light Theme Mode
- Localized UI language
- Pinned Posts on Home Page
- Hierarchical Categories
- Trending Tags
- Table of Contents
- Last Modified Date
- Syntax Highlighting
- Mathematical Expressions
- Mermaid Diagrams & Flowcharts
- Dark / Light Mode Images
- Embed Videos
- Disqus / Giscus / Utterances Comments
- Built-in Search
- Atom Feeds
- PWA
- Google Analytics / GoatCounter
- SEO & Performance Optimization
```
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
```

## Documentation
安装 ruby-build

To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki].
```
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
```

## Contributing
安装 ruby

Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place
to learn, inspire, and create. Any contributions you make are greatly appreciated.
For details, see the "[Contributing Guidelines][contribute-guide]".
```
rbenv install 3.1.2
rbenv global 3.1.2
```

## Credits
安装 jekyll

### Contributors
```
gem install jekyll bundler
```

Thanks to [all the contributors][contributors] involved in the development of the project!
### 2. 运行

[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16)][contributors]
<sub> —— Made with [contrib.rocks](https://contrib.rocks)</sub>
```
git clone https://github.com/zhengtianbao/zhengtianbao.github.io.git
```

### Third-Party Assets
安装依赖

This project is built on the [Jekyll][jekyllrb] ecosystem and some [great libraries][lib], and is developed using [VS Code][vscode] as well as tools provided by [JetBrains][jetbrains] under a non-commercial open-source software license.
```
bundle install
bundle
```

The avatar and favicon for the project's website are from [ClipartMAX][clipartmax].
启动本地服务

## License
```
bundle exec jekyll s
```

This project is published under [MIT License][license].

[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster
[codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
[license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE
[jekyllrb]: https://jekyllrb.com/
[clipartmax]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/
[demo]: https://cotes2020.github.io/chirpy-demo/
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md
[contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors
[lib]: https://github.com/cotes2020/chirpy-static-assets
[vscode]: https://code.visualstudio.com/
[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy
访问地址: http://127.0.0.1:4000

0 comments on commit 8d54bd2

Please sign in to comment.