sharpetronics/jekyll-spaceship
1
0
Fork 0
mirror of https://github.com/SharpeTronics/jekyll-spaceship.git synced 2025-12-24 00:03:59 -05:00
Code Issues Projects Releases Wiki Activity

docs: update README.md

Browse Source
This commit is contained in:
jeffreytse 2020-05-19 03:38:56 +08:00
parent 76a96c3a4e
commit fe53c63d50
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -82,6 +82,13 @@
A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji, youtube, vimeo, dailymotion, etc.
<p align="center">
<img alt="Jekyll Spaceship Demo" src="https://user-images.githubusercontent.com/9413601/82250463-15451780-997e-11ea-8809-f411586d9508.gif" alt="Donate (Ko-fi)" />
</p>
**💡 Tip:** I hope you enjoy using this plugin. If you like this project, **a little star** for it is your way make a clear statement: **My work is valued**. I would appreciate your support! _Thank you!_
## Table of Contents
- [Requirements](#requirements)
@ -128,6 +135,8 @@ plugins:
- jekyll-spaceship
```
**💡 Tip:** Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins](https://pages.github.com/versions/). To use the gem in GitHub Pages, you need to build locally or use CI (e.g. [travis](https://travis-ci.org/), [github workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)) and deploy to your `gh-pages` branch. [Click here for more information.](https://jekyllrb.com/docs/continuous-integration/github-actions/)
## Usage
### 1. Table Usage