From 65bee134e52ac4da925e1b331fa6aef75947bc69 Mon Sep 17 00:00:00 2001 From: jeffreytse Date: Tue, 1 Sep 2020 18:24:26 +0800 Subject: docs: update README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index d00f876..0c06028 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,23 @@ Hey, nice to meet you, you found this Jekyll theme. Here the yet another theme i

+## Features + +- Full layouts `home`, `post`, `tags`, `archive` and `about`. +- Uses font awesome 5 for icons. +- Beautiful Syntax Highlight using [hilight.js][hilight-js]. +- RSS support using [Jekyll Feed][jekyll-feed] gem. +- Optimized for search engines using [Jekyll Seo Tag][jekyll-seo-tag] gem. +- Sitemap support using [Jekyll Sitemap][jekyll-sitemap] gem. +- Complex and flexible table support using [Jekyll Spaceship][jekyll-spaceship] gem. +- MathJAX and LaTeX optional support using [Jekyll Spaceship][jekyll-spaceship] gem. +- Media (Youtube, Spotify, etc.) support using [Jekyll Spaceship][jekyll-spaceship] gem. +- Diagram (PlantUML, Mermaid) support using [Jekyll Spaceship][jekyll-spaceship] gem. +- Google Translation support. +- New post tag support. + +Also, visit the live [demo][yat-live-demo] site for the theme. + ## Installation Add this line to your Jekyll site's `Gemfile`: @@ -67,3 +84,13 @@ You can start by [opening an issue](https://github.com/jeffreytse/jekyll-theme-y ## License This theme is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php) © JeffreyTse. + + +[jekyll]: https://jekyllrb.com/ +[yat-git-repo]: https://github.com/jeffreytse/jekyll-theme-yat/ +[yat-live-demo]: https://jeffreytse.github.io/jekyll-theme-yat/ +[jekyll-spaceship]: https://github.com/jeffreytse/jekyll-spaceship +[jekyll-seo-tag]: https://github.com/jekyll/jekyll-seo-tag +[jekyll-sitemap]: https://github.com/jekyll/jekyll-sitemap +[jekyll-feed]: https://github.com/jekyll/jekyll-feed +[hilight-js]: https://github.com/highlightjs/highlight.js -- cgit v1.2.3