From b2056af1be1617b291c18ea595cb82377060c08e Mon Sep 17 00:00:00 2001 From: moonrailgun Date: Tue, 29 Nov 2022 18:06:17 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=A2=9E=E5=8A=A0=E5=AF=8C=E6=96=87?= =?UTF-8?q?=E6=9C=AC=E4=BD=BF=E7=94=A8=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website/docs/advanced-usage/_category_.json | 4 +++ website/docs/advanced-usage/richtext.md | 34 +++++++++++++++++++++ website/docs/cli/_category_.json | 2 +- website/package.json | 2 +- website/src/css/custom.css | 5 +++ 5 files changed, 45 insertions(+), 2 deletions(-) create mode 100644 website/docs/advanced-usage/_category_.json create mode 100644 website/docs/advanced-usage/richtext.md diff --git a/website/docs/advanced-usage/_category_.json b/website/docs/advanced-usage/_category_.json new file mode 100644 index 00000000..eef3f4d2 --- /dev/null +++ b/website/docs/advanced-usage/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "进阶使用", + "position": 30 +} diff --git a/website/docs/advanced-usage/richtext.md b/website/docs/advanced-usage/richtext.md new file mode 100644 index 00000000..da37f015 --- /dev/null +++ b/website/docs/advanced-usage/richtext.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +title: 富文本语法 +--- + +## 对于普通用户 + +Tailchat 内置了 `com.msgbyte.bbcode` 插件用于对富文本消息做支持(且是默认安装的)。 + +以下是目前 `bbcode` 插件支持的语法列表: + +| 关键字 | 描述 | 用法示例 | 预览 | +| ------ | ----- | ------ | ----- | +| b | 文本加粗 | `[b]foo[/b]` | foo | +| i | 文本倾斜 | `[i]foo[/i]` | foo | +| u | 文本下划线 | `[u]foo[/u]` | foo | +| s | 文本删除线 | `[s]foo[/s]` | foo | +| url | 超链接 |
`[url]https://tailchat.msgbyte.com[/url]` / `[url=https://tailchat.msgbyte.com]官网[/url]`
| https://tailchat.msgbyte.com / 官网 | +| img | 图片 | `[img]https://tailchat.msgbyte.com/img/logo.svg[/img]` |
| +| at | 提及 | `[at=]moonrailgun[/at]` | - | +| emoji | 表情 | `[emoji]smile[/emoji]` | - | +| markdown / md | markdown语法支持 | `[markdown]## Heading[/markdown]` | - | + +## 对于插件开发者 + +如果你的插件需要使用统一的富文本支持,请在你的渲染函数中这样实现: + +```jsx +import { getMessageRender } from '@capital/common'; + +const Component = (text: string) => { + return
{getMessageRender(text)}
+} +``` diff --git a/website/docs/cli/_category_.json b/website/docs/cli/_category_.json index 54f8596f..be233a0e 100644 --- a/website/docs/cli/_category_.json +++ b/website/docs/cli/_category_.json @@ -1,4 +1,4 @@ { "label": "命令行终端", - "position": 30 + "position": 40 } diff --git a/website/package.json b/website/package.json index 06e66f6c..ed48ee2d 100644 --- a/website/package.json +++ b/website/package.json @@ -4,7 +4,7 @@ "private": true, "scripts": { "docusaurus": "docusaurus", - "start": "docusaurus start -p 11033", + "dev": "docusaurus start -p 11033", "build": "docusaurus build", "swizzle": "docusaurus swizzle --typescript", "deploy": "docusaurus deploy", diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 2578d78f..6ddbb985 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -31,3 +31,8 @@ html[data-theme='dark'] .docusaurus-highlight-code-line { .medium-zoom-image--opened { z-index: var(--ifm-z-index-fixed); } + +table th { + /* 表头不换行 */ + white-space: nowrap; +}