Skip to content

Commit

Permalink
docs: 修订文档
Browse files Browse the repository at this point in the history
  • Loading branch information
HowieHz committed Dec 11, 2024
1 parent 013e5a1 commit f5f1be1
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
- CSP: upgrade-insecure-requests
- 文章页标题自定义
- 完善的多语言支持(多语言文字支持,多语言菜单支持,详情请见文档[i18n 支持指南](#i18n-支持指南)
- [Mermaid 明暗切换支持](#mermaid-明暗切换支持), [设置内容仅在浅色/深色模式下显示](#设置内容仅在浅色深色模式下显示)
5. 更多功能等您来探索...

### 作者的碎碎语
Expand Down Expand Up @@ -88,6 +89,9 @@
- [Mermaid 明暗切换支持](#mermaid-明暗切换支持)
- [使用默认编辑器](#使用默认编辑器)
- [使用 Vditor 编辑器](#使用-vditor-编辑器)
- [设置内容仅在浅色/深色模式下显示](#设置内容仅在浅色深色模式下显示)
- [使用默认编辑器](#使用默认编辑器-1)
- [使用 Vditor 编辑器](#使用-vditor-编辑器-1)
- [进行此项目的开发](#进行此项目的开发)
- [开发前准备](#开发前准备)
- [安装 pnpm](#安装-pnpm)
Expand Down Expand Up @@ -465,6 +469,49 @@ title: [[图表标题]]
</div>
````

## 设置内容仅在浅色/深色模式下显示

### 使用默认编辑器

1. 需插件 [plugin-hybrid-edit-block](https://github.com/halo-sigs/plugin-hybrid-edit-block)
2. 默认编辑器中输入 `/html` 选择插入 html 代码块

输入以下内容,将 `[[浅色模式内容]]``[[深色模式内容]]` 换成你自己的内容,
即可适配明暗切换

```
<div class="dark">
[[深色模式内容]]
</div>
<div class="light">
[[浅色模式内容]]
</div>
```

### 使用 [Vditor 编辑器](https://github.com/justice2001/halo-plugin-vditor)

输入以下内容,将 `[[浅色模式内容]]``[[深色模式内容]]` 换成你自己的内容,
即可适配明暗切换

```
<div class="dark">
[[深色模式内容]]
</div>
<div class="light">
[[浅色模式内容]]
</div>
```

## 进行此项目的开发

首先请确保你的编辑器支持 EditorConfig,这保证了项目代码格式的统一。
Expand Down

0 comments on commit f5f1be1

Please sign in to comment.