first commit

README.md

@@ -1,5 +1,32 @@
-# k-hexo-shortcode-plugin
+## 一个 Hexo 的短代码插件
 
-A simple shortcode plugin for Hexo
+虽然官方正式名称应该叫标签插件，但我更愿意叫它短代码插件
 
-# ***注意本插件正处于开发阶段***
+> [标签插件（Tag）](https://hexo.io/zh-cn/api/tag)
+> 标签插件帮助开发者在文章中快速插入内容。
+
+通过短代码，你可以很轻松的在文本中插入隐藏文本、提示等等。能让你的文章表达形式更加丰富
+
+## ***注意本插件正处于开发阶段***
+
+## 短代码
+
+### 隐藏文本
+
+#### 介绍
+
+该短代码可以插入一段隐藏文本。
+
+#### 用法
+
+```md
+{% hidden 内容 参数名:参数%}
+```
+
+#### 参数
+
+
+| 参数名 | 可选值          | 默认值 | 解释                       | 是否必须 |
+| ------ | --------------- | ------ | -------------------------- | -------- |
+| type   | blur/background | blur   | 隐藏的形式 (模糊/黑条)     | 否       |
+| color  | 字符串          | 无     | 鼠标移上一段时间后显示的话 | 否       |