From 16170659f7e19d535f1d681baa7379c9a0d5d8e4 Mon Sep 17 00:00:00 2001 From: jeffreytse Date: Mon, 1 Feb 2021 23:22:39 +0800 Subject: [PATCH] docs: update README.md --- README.md | 76 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 60 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 457e1d3..9d813a6 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,57 @@ -# jekyll-theme-yat -[![Github Pages](https://github.com/jeffreytse/jekyll-theme-yat/workflows/Github%20Pages/badge.svg)](https://jeffreytse.github.io/jekyll-theme-yat) -[![Gem Version](https://badge.fury.io/rb/jekyll-theme-yat.svg)](http://badge.fury.io/rb/jekyll-theme-yat) -[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) -[![Donate (Liberapay)](http://img.shields.io/liberapay/goal/jeffreytse.svg?logo=liberapay)](https://liberapay.com/jeffreytse) -[![Donate (Patreon)](https://img.shields.io/badge/support-patreon-F96854.svg?style=flat-square)](https://patreon.com/jeffreytse) - +
+
+ +
+ jekyll-theme-yat →~ jekyll + + +

🎨 JEKYLL YAT THEME 🎨

+ +
+ +

+ Jekyll theme for elegant writers. +

+ +

+ + Github Pages + + + + Gem Version + + + + License: MIT + + + + Donate (Liberapay) + + + + Donate (Patreon) + + + Donate (Ko-fi) - + alt="Donate (Ko-fi)" /> + +

+ +
+ Built with ❤︎ by + jeffreytse and + contributors +
+ +
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, @@ -29,7 +73,7 @@ a star!**

-## Features +## ✨ Features - Support beautiful __Night Mode__. - Modern responsive web design. @@ -48,7 +92,7 @@ a star!** Also, visit the [Live Demo][yat-live-demo] site for the theme. -## Installation +## 🛠️ Installation There are three ways to install: @@ -107,7 +151,7 @@ And then execute: $ bundle ``` -## GitHub Pages without limitation +### 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__. @@ -116,11 +160,11 @@ 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`. @@ -129,13 +173,13 @@ 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.