feat: add documemt.

This commit is contained in:
jaywcjlove
2022-09-03 15:39:06 +08:00
parent d806339c26
commit 57b719c163
7 changed files with 52 additions and 13 deletions

View File

@@ -66,13 +66,20 @@ Inline Code `{code: 0}`
### 支持注释
```html
<ruby>
<rp></rp><rt>Han</rt><rp></rp>
字 <rp></rp><rt>zi</rt><rp></rp>
拼 <rp></rp><rt>pin</rt><rp></rp>
音 <rp></rp><rt>yin</rt><rp></rp>
注 <rp></rp><rt>zhu</rt><rp></rp>
音 <rp></rp><rt>yin</rt><rp></rp>
<rt>Han</rt>
</ruby>
```
汉字注音效果:
<ruby>
汉 <rt>Han</rt>
字 <rt>zi</rt>
拼 <rt>pin</rt>
音 <rt>yin</rt>
注 <rt>zhu</rt>
音 <rt>yin</rt>
</ruby>
### 支持自定义样式
@@ -100,6 +107,20 @@ Inline Code `{code: 0}`
<!--rehype:ignore:start-->内容在微信 Markdown 编辑器预览中不显示。在其它预览工具中展示内容。<!--rehype:ignore:end-->
```
### 支持 URL 参数加载 Markdown 内容
```
https://<URL>?md=<Markdown 资源 URL>
```
加载 Markdown 内容的示例 URL
```
https://jaywcjlove.github.io/wxmp/#/?theme=underscore&md=https%3A%2F%2Fraw.githubusercontent.com%2Fuiwjs%2Freact-markdown-editor%2Fmaster%2FREADME.md
Markdown URL 地址: https://raw.githubusercontent.com/uiwjs/react-markdown-editor/master/README.md
```
## 主题定制
在目录 `src/themes` 中存放默认主题,在 `src/store/context.tsx` 中配置主题,主题使用 css 定义样式,不支持复杂的选择器。提供在线主题编辑器,欢迎修改并 PR 进仓库供大家使用。