Skip to content
This repository has been archived by the owner on Jul 25, 2023. It is now read-only.

Commit

Permalink
chore: add readme info
Browse files Browse the repository at this point in the history
  • Loading branch information
FlysoftBeta committed Jul 19, 2023
1 parent 71b988c commit 624f705
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 2 deletions.
Binary file added .github/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,48 @@
# QQNTim 模板插件
# QQNTim Markdown 及 LaTeX 渲染插件

## 简介

本插件让 QQNT 支持 Markdown 及 LaTeX 渲染。需要安装 [QQNTim](https://github.com/Flysoft-Studio/QQNTim) 才能使用。

效果图:

![截图](.github/screenshot.png)

效果图中使用的 Markdown:

````md
<md>
### 标题

正常、**粗体**、~~删除线~~、_斜体_、`代码 code`

```bash
echo "代码文本" > /dev/null
```

表情符号和 Markdown 混合:**你好[表情]文本**

图片:[图片]

表格:

| 名称 | 说明 |
| -------- | -------- |
| 项 目 一 | 说 明 一 |
| 项 目 二 | 说 明 二 |

$$\sum_{k=1}^n k^2 = \frac{1}{2} n (n+1)$$
````

## 使用

### Markdown 消息

在消息头部插入 `<md>``<markdown>`(可自定义)即可使用 Markdown 渲染你的消息。

### LaTeX 渲染

**在 Markdown 消息**中使用 ` $` 包裹公式以使用内联模式(Inline Mode)显示公式,或使用 `$$` 包裹公式以使用外显模式(Display Mode)显示公式。

## 开发

Expand Down
2 changes: 1 addition & 1 deletion src/settings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ function SettingsPanel({ config: _config, setConfig: _setConfig }: QQNTim.Settin
<SettingsSection title="使用方法">
<SettingsBox>
<SettingsBoxItem title="Markdown 消息" description={[`在消息头部插入 ${currentPluginConfig.markdownFlags.split(",").join(" 或 ")} 即可使用 Markdown 渲染你的消息。`]} />
<SettingsBoxItem title="LaTeX 渲染" description={["在 Markdown 消息中将公式使用 $ 包裹以使用内联模式(Inline Mode)显示,或将公式使用 $$ 包裹以使用外显模式(Display Mode)显示。"]} />
<SettingsBoxItem title="LaTeX 渲染" description={["在 Markdown 消息中使用 $ 包裹公式以使用内联模式(Inline Mode)显示公式,或使用 $$ 包裹公式以使用外显模式(Display Mode)显示公式。"]} />
</SettingsBox>
</SettingsSection>
<SettingsSection title="插件设置">
Expand Down

0 comments on commit 624f705

Please sign in to comment.