docs: update README.md
This commit is contained in:
parent
33e006dbca
commit
65bee134e5
27
README.md
27
README.md
|
@ -18,6 +18,23 @@ Hey, nice to meet you, you found this Jekyll theme. Here the yet another theme i
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
## 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
|
## Installation
|
||||||
|
|
||||||
Add this line to your Jekyll site's `Gemfile`:
|
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
|
## License
|
||||||
|
|
||||||
This theme is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php) © JeffreyTse.
|
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/
|
||||||
|
[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
|
||||||
|
|
Loading…
Reference in a new issue