diff --git a/README.md b/README.md index 63effc2..be19bd6 100644 --- a/README.md +++ b/README.md @@ -80,10 +80,10 @@
-A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji, youtube, vimeo, dailymotion, etc. +Spaceship is a minimalistic, powerful and extremely customizable [Jekyll](https://jekyllrb.com/) plugin. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.

- Jekyll Spaceship Demo + Jekyll Spaceship Demo

**💡 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!_ @@ -109,10 +109,12 @@ A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, emoji - [4.1 Youtube Usage](#youtube-usage) - [4.2 Vimeo Usage](#vimeo-usage) - [4.3 DailyMotion Usage](#dailymotion-usage) + - [4.4 General Video Usage](#general-video-usage) - [5. Hybrid HTML with Markdown](#5-hybrid-html-with-markdown) - [6. Markdown Polyfill](#6-markdown-polyfill) - [6.1 Escape Ordered List](#escape-ordered-list) - [7. Emoji Usage](#7-emoji-usage) + - [7.1 Emoji Customizing](#71-emoji-customizing) - [Credits](#credits) - [Contributing](#contributing) - [License](#license) @@ -576,6 +578,7 @@ While its not possible to embed a video in markdown, the best and easiest way is - Youtube - Vimeo - DailyMotion +- General Video ( mp4 | avi | webm | ogg | ogv | 3gp | flv | mov ... ) There are two ways to embed a video in your Jekyll blog page: @@ -634,6 +637,21 @@ the link as below: ![](https://dai.ly/x7tgcev?width=100%&height=400) ``` +#### General Video Usage + +```markdown +![](//www.html5rocks.com/en/tutorials/video/basics/devstories.webm) +``` + +```markdown +![](//techslides.com/demos/sample-videos/small.ogv?allow=autoplay) +``` + +```markdown +![](//techslides.com/demos/sample-videos/small.mp4?width=400) +``` + + ### 5. Hybrid HTML with Markdown As markdown is not only a lightweight markup language with plain-text-formatting syntax, but also an easy-to-read and easy-to-write plain text format, so writing a hybrid HTML with markdown is an awesome choice. @@ -725,6 +743,19 @@ I give this plugin two :+1:! I give this plugin two :+1:! +#### 7.1 Emoji Customizing + +If you'd like to serve emoji images locally, or use a custom emoji source, you can specify so in your `_config.yml` file: + +```yml +jekyll-spaceship: + emoji-processor: + src: "/assets/images/emoji" +``` + +See the [Gemoji](https://github.com/github/gemoji) documentation for generating image files. + + ## Credits - [Jekyll](https://github.com/jekyll/jekyll) - A blog-aware static site generator in Ruby.