[shardingsphere] branch master updated: update docs/readme.md by cayman (#6418)

[zh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git


The following commit(s) were added to refs/heads/master by this push:
     new b68825b  update docs/readme.md by cayman (#6418)
b68825b is described below

commit b68825bfa860df107b922d4b741c5dd335ae5d29
Author: CaymanHK <55...@users.noreply.github.com>
AuthorDate: Thu Jul 23 16:05:26 2020 +0800

    update docs/readme.md by cayman (#6418)
    
    * support media: youtube and bilibili by cayman
    
    * modify menu.html
    
    * update docs/readme.md by cayman
---
 docs/README.md | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index bad7ace..7f0ee1d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,5 +1,9 @@
 # ShardingSphere Documents
 
+ ‍
+
+#### HOW to build ShardingSphere website ?
+
 To build ShardingSphere website by means of [hugo](http://gohugo.io/overview/introduction/) and [hugo theme learn](https://github.com/matcornic/hugo-theme-learn).
 
 Follow the steps below to deploy ShardingSphere website, 
@@ -10,5 +14,26 @@ Follow the steps below to deploy ShardingSphere website,
 3. Overwrite `document/current` with `docs/target/document/current`, `community` with `docs/target/community` and `blog` with `docs/target/blog`.
 4. Commit changes and raise a PR for [shardingsphere-doc](https://github.com/apache/shardingsphere-doc.git).
 
-Note,
-1. If you modify `docs/build.sh`, please test it locally.
\ No newline at end of file
+ ‍
+
+#### Note :
+
+1. If you modify `docs/build.sh`, please test it locally.
+
+ ‍
+
+#### HOW to insert a video of Bilibili or YouTube ?
+
+1. First please make sure you get the corret url of the video you wanna add.
+
+2. - DO REMEMBER use the `bvid argument` of bilibili url :
+
+     for example : https://www.bilibili.com/video/BV1aE411X7kQ?from=search&seid=5978719442257399675 ( bvid argument means `BV1aE411X7kQ` , or you can simply recognize the argument with `Capital Letter` )
+
+   - YouTube url is much easier to recognize : https://www.youtube.com/watch?v=2MsN8gpT6jY , the argument you needed is `2MsN8gpT6jY` at the end of the url.
+
+3. use the shortcodes at wherever you want to place :
+
+   - `{{< bilibili BV1aE411X7kQ >}}`
+
+   - `{{< youtube 2MsN8gpT6jY >}}`
\ No newline at end of file