Initial MDHelper implementation

This commit is contained in:
shenw
2026-05-25 17:12:00 +08:00
commit 50b15b02c7
45 changed files with 11654 additions and 0 deletions
+149
View File
@@ -0,0 +1,149 @@
# 示例帮助文档
## 功能演示
### 1. 文字格式
这是**粗体**文字,这是*斜体*文字,这是~~删除线~~。
> 这是一段引用文本
无序列表:
- 第一项
- 第二项
- 第三项
有序列表:
1. 步骤一
2. 步骤二
3. 步骤三
### 2. 表格示例
| 功能 | 描述 | 状态 |
|------|------|------|
| 文字渲染 | Markdown 完整支持 | ✅ |
| 表格显示 | 美化表格样式 | ✅ |
| 代码高亮 | 伪代码语法高亮 | ✅ |
| 图片展示 | 支持多种格式 | ✅ |
| 音频播放 | 内置播放器 | ✅ |
| 动画播放 | GIF/视频支持 | ✅ |
### 3. 伪代码示例
```pseudocode
BEGIN
SET sum = 0
FOR i = 1 TO 10 DO
sum = sum + i
IF sum > 50 THEN
RETURN sum
END IF
END FOR
RETURN sum
END
```
### 4. 代码块示例
```python
def fibonacci(n):
"""计算斐波那契数列"""
if n <= 1:
return n
return fibonacci(n-1) + fibonacci(n-2)
# 测试
print(fibonacci(10)) # 输出: 55
```
### 5. 图片示例
将图片放在 `media` 文件夹中,使用相对路径引用:
```markdown
![截图](media/screenshot.png)
```
实际显示:
![示例图片](media/screenshot.png)
> **提示**: 支持 PNG、JPG、GIF 等常见图片格式
### 6. 音频示例
将音频文件放在 `media` 文件夹中:
```markdown
![音频说明](media/demo.mp3)
```
实际播放:
![背景音乐](media/demo.mp3)
> **提示**: 支持 MP3、WAV、OGG 等音频格式
### 7. 视频/动画示例
将视频文件放在 `media` 文件夹中:
```markdown
![视频说明](media/demo.mp4)
```
实际播放:
![演示视频](media/demo.mp4)
> **提示**: 支持 MP4、AVI、MOV 等视频格式
### 8. GIF 动画示例
GIF 动图会自动播放:
```markdown
![动画](media/animation.gif)
```
实际显示:
![动画效果](media/animation.gif)
### 9. Markdown 扩展示例
任务列表:
- [x] 完成 Markdown 基础渲染
- [x] 支持本地媒体播放
- [ ] 补充更多项目文档
提示块:
> [!TIP] 阅读提示
> 可以点击图片放大查看,也可以在表格右上角复制表格内容。
> [!WARNING] 文件提示
> 打开非 Markdown 本地文件前,MDHelper 会先询问是否使用系统默认软件。
### 10. 链接
访问 [项目主页](https://www.pkuncii.com/)
或链接到 [用户手册](docs/user_manual.md)
或链接到 [演示视频](media/demo.mp4)
内部锚点跳转:[跳转到表格示例](#2-表格示例)
---
## 使用技巧
1. **文件浏览**: 使用左侧面板浏览 Markdown 文件
2. **快速搜索**: 在文件浏览器中使用 Ctrl+F 搜索
3. **全屏阅读**: 按 F11 进入全屏模式
4. **媒体支持**: 将图片、音频、视频放在 `media` 文件夹中
> **提示**: 支持相对路径引用同目录下的图片和音频文件。