Skip to content

Commit 3001c74

Browse files
committed
docs: update README.md
1 parent 0fea688 commit 3001c74

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<img alt="jekyll-theme-yat →~ jekyll" src="https://user-images.githubusercontent.com/9413601/106478481-346fdf00-64e4-11eb-9385-1ab5329c3234.png" width="600">
66
</a>
77

8-
<h1>🎨 JEKYLL YAT THEME 🎨</h1>
8+
<h1>JEKYLL YAT THEME</h1>
99

1010
</div>
1111

@@ -49,36 +49,42 @@
4949
<sub>Built with ❤︎ by
5050
<a href="https://jeffreytse.net">jeffreytse</a> and
5151
<a href="https://github.com/jeffreytse/jekyll-theme-yat/graphs/contributors">contributors </a>
52+
</sub>
5253
</div>
5354

5455
<br>
5556

5657
Hey, nice to meet you, you found this [Jekyll][jekyll] theme. Here the
57-
**Yet Another Theme** is a modern responsive theme, and it's quiet clear,
58-
clean and neat for writers and posts. **If you like the theme, give it
59-
a star!**
58+
_YAT (Yet Another Theme)_ is a modern responsive theme. It's quiet
59+
clear, clean and neat for writers and posts. **If you are an elegant
60+
writer and focus on content, don't miss it.**
6061

62+
<p align="center">
63+
Like this elegant theme? You can give it a star or sponsor me!<br>
64+
I will respect your crucial support and say THANK YOU!
65+
</p>
6166

6267
<p align="center">
6368

64-
<img src="https://user-images.githubusercontent.com/9413601/91842897-6a840b00-ec87-11ea-95ca-52abcc1ac063.png" alt="demo-screenshot" width="780px"/>
69+
<img src="https://user-images.githubusercontent.com/9413601/91842897-6a840b00-ec87-11ea-95ca-52abcc1ac063.png" alt="demo-screenshot" width="100%"/>
6570

6671
</p>
6772

68-
<h3 align="center">🌌 Night Mode</h3>
73+
<h4 align="center">BANNER</h4>
6974

7075
<p align="center">
7176

72-
<img src="https://user-images.githubusercontent.com/9413601/94983351-760f6e00-0574-11eb-9494-5303ad6228dc.gif" alt="demo-screenshot" width="780px"/>
77+
<img src="https://user-images.githubusercontent.com/9413601/123897812-ae729a00-d996-11eb-96b8-b76ba926f555.gif" alt="demo-screenshot" width="100%"/>
7378

7479
</p>
7580

76-
## Features
81+
## Features
7782

78-
- Support beautiful __Night Mode__.
83+
- Support beautiful **Night Mode**.
7984
- Modern responsive web design.
8085
- Full layouts `home`, `post`, `tags`, `archive` and `about`.
8186
- Uses font awesome 5 for icons.
87+
- Beautiful page banner with _image_ and _video_.
8288
- Beautiful Syntax Highlight using [highlight.js][highlight-js].
8389
- RSS support using [Jekyll Feed][jekyll-feed] gem.
8490
- Optimized for search engines using [Jekyll Seo Tag][jekyll-seo-tag] gem.
@@ -92,7 +98,7 @@ a star!**
9298

9399
Also, visit the [Live Demo][yat-live-demo] site for the theme.
94100

95-
## 🛠️ Installation
101+
## Installation
96102

97103
There are three ways to install:
98104

@@ -153,18 +159,17 @@ $ bundle
153159

154160
### GitHub Pages without limitation
155161

156-
GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins/themes](https://pages.github.com/versions/). __In other words, the third-party gems will not work normally__.
162+
GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins/themes](https://pages.github.com/versions/). **In other words, the third-party gems will not work normally**.
157163

158164
To use the third-party gem in GitHub Pages without limitation:
159165

160166
Here is a GitHub Action named [jekyll-deploy-action](https://github.com/jeffreytse/jekyll-deploy-action) for Jekyll site deployment conveniently. 👍
161167

162-
163-
## 📚 Usage
168+
## Usage
164169

165170
Add or update your available layouts, includes, sass and/or assets.
166171

167-
## ✏️ Development
172+
## Development
168173

169174
To set up your environment to develop this theme, run `bundle install`.
170175

@@ -173,17 +178,18 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
173178
When your theme is released, only the files in `_data`, `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
174179
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-yat.gemspec` accordingly.
175180

176-
## 🔫 Contributing
181+
## Contributing
177182

178183
Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.
179184

180185
You can start by [opening an issue](https://github.com/jeffreytse/jekyll-theme-yat/issues/new) describing the problem that you're looking to resolve and we'll go from there.
181186

182-
## 🌈 License
187+
## License
183188

184189
This theme is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php) © JeffreyTse.
185190

186191
<!-- External links -->
192+
187193
[jekyll]: https://jekyllrb.com/
188194
[yat-git-repo]: https://github.com/jeffreytse/jekyll-theme-yat/
189195
[yat-live-demo]: https://jeffreytse.github.io/jekyll-theme-yat/

0 commit comments

Comments
 (0)