summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjeffreytse <jeffreytse.mail@gmail.com>2021-06-30 11:38:13 +0800
committerjeffreytse <jeffreytse.mail@gmail.com>2021-06-30 11:43:39 +0800
commit826e97f27e323fdb33808b795998f121c571a95d (patch)
treef28e00c4dd5a8d8ea72e9553c5936546e5fe925a
parent0fea688977e16c1f1f42c23b36b14ed325ee606b (diff)
docs: update README.md
-rw-r--r--README.md38
1 files changed, 22 insertions, 16 deletions
diff --git a/README.md b/README.md
index 459c70c..f25f7a6 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
<img alt="jekyll-theme-yat →~ jekyll" src="https://user-images.githubusercontent.com/9413601/106478481-346fdf00-64e4-11eb-9385-1ab5329c3234.png" width="600">
</a>
- <h1>🎨 JEKYLL YAT THEME 🎨</h1>
+ <h1>JEKYLL YAT THEME</h1>
</div>
@@ -49,36 +49,42 @@
<sub>Built with ❤︎ by
<a href="https://jeffreytse.net">jeffreytse</a> and
<a href="https://github.com/jeffreytse/jekyll-theme-yat/graphs/contributors">contributors </a>
+ </sub>
</div>
<br>
Hey, nice to meet you, you found this [Jekyll][jekyll] theme. Here the
-**Yet Another Theme** is a modern responsive theme, and it's quiet clear,
-clean and neat for writers and posts. **If you like the theme, give it
-a star!**
+_YAT (Yet Another Theme)_ is a modern responsive theme. It's quiet
+clear, clean and neat for writers and posts. **If you are an elegant
+writer and focus on content, don't miss it.**
+<p align="center">
+Like this elegant theme? You can give it a star or sponsor me!<br>
+I will respect your crucial support and say THANK YOU!
+</p>
<p align="center">
- <img src="https://user-images.githubusercontent.com/9413601/91842897-6a840b00-ec87-11ea-95ca-52abcc1ac063.png" alt="demo-screenshot" width="780px"/>
+ <img src="https://user-images.githubusercontent.com/9413601/91842897-6a840b00-ec87-11ea-95ca-52abcc1ac063.png" alt="demo-screenshot" width="100%"/>
</p>
-<h3 align="center">🌌 Night Mode</h3>
+<h4 align="center">BANNER</h4>
<p align="center">
- <img src="https://user-images.githubusercontent.com/9413601/94983351-760f6e00-0574-11eb-9494-5303ad6228dc.gif" alt="demo-screenshot" width="780px"/>
+ <img src="https://user-images.githubusercontent.com/9413601/123897812-ae729a00-d996-11eb-96b8-b76ba926f555.gif" alt="demo-screenshot" width="100%"/>
</p>
-## ✨ Features
+## Features
-- Support beautiful __Night Mode__.
+- Support beautiful **Night Mode**.
- Modern responsive web design.
- Full layouts `home`, `post`, `tags`, `archive` and `about`.
- Uses font awesome 5 for icons.
+- Beautiful page banner with image and video.
- Beautiful Syntax Highlight using [highlight.js][highlight-js].
- RSS support using [Jekyll Feed][jekyll-feed] gem.
- Optimized for search engines using [Jekyll Seo Tag][jekyll-seo-tag] gem.
@@ -92,7 +98,7 @@ a star!**
Also, visit the [Live Demo][yat-live-demo] site for the theme.
-## 🛠️ Installation
+## Installation
There are three ways to install:
@@ -153,18 +159,17 @@ $ bundle
### GitHub Pages without limitation
-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__.
+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**.
To use the third-party gem in GitHub Pages without limitation:
Here is a GitHub Action named [jekyll-deploy-action](https://github.com/jeffreytse/jekyll-deploy-action) for Jekyll site deployment conveniently. 👍
-
-## 📚 Usage
+## Usage
Add or update your available layouts, includes, sass and/or assets.
-## ✏️ Development
+## Development
To set up your environment to develop this theme, run `bundle install`.
@@ -173,17 +178,18 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
When your theme is released, only the files in `_data`, `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-yat.gemspec` accordingly.
-## 🔫 Contributing
+## Contributing
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.
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.
-## 🌈 License
+## License
This theme is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php) © JeffreyTse.
<!-- External links -->
+
[jekyll]: https://jekyllrb.com/
[yat-git-repo]: https://github.com/jeffreytse/jekyll-theme-yat/
[yat-live-demo]: https://jeffreytse.github.io/jekyll-theme-yat/