文档工具
简介
本工具是一个文档生成工具，可以将 Markdown 编写的内容，生成交互丰富的文档，并生成可以轻松部署到任何地方的 HTML 网页。
注意
本篇文档是现在仅作为示例，部分能力还在完善中，不能作为最终的使用文档
交互丰富的内容：
1. 生成步骤式导航
2. 漂亮的链接块
Android
iOS
Vue2.1 漂亮的 platform 链接块
3. 标签导航栏
即时通信 IM 基于腾讯二十余年的 IM 技术积累，支持全平台且跨终端互通，低代码 UI 组件助您30分钟集成单聊、群聊、关系链、消息漫游、群组管理、资料管理、直播弹幕和内容审核等能力。
实时音视频基于腾讯21年来在网络与音视频技术上的深度积累，以多人音视频通话和低延时互动直播两大场景化方案，通过腾讯云服务向开发者开放，致力于帮助开发者快速搭建低成本、低延时、高品质的音视频互动解决方案。
腾讯云联络中心是帮助企业快速搭建集电话、在线交流、音视频通话为一体的客户联络平台。支持被集成于SaaS或业务系统，为企业客服、销售、线下门店沟通、混合办公等场景提供灵活稳定的一体化云联络中心。
4. 在代码块中实现行高亮
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}5. 预览代码效果
（先欠着 🥹🥹）
安装与启动
前置准备
使用以下方式安装它：
# 安装
pnpm i运行
# 启动文档
npm run doc-dev文件结构
假设选择在 ./docs 中搭建文档，生成的文件结构应该是这样的：
.
└─ docs
├─ guide
│ ├─ getting-started.md
│ └─ index.md
├─ index.md
└─ prologue.mddocs 目录作为站点的项目根目录。
生成的 HTML 页面会是这样：
index.md --> /index.html (可以通过 / 访问)
prologue.md --> /prologue.html
guide/index.md --> /guide/index.html (可以通过 /guide/ 访问)
guide/getting-started.md --> /guide/getting-started.html生成的 HTML 可以托管在任何支持静态文件的 Web 服务器上。
写作
支持所有 markdown 语法
另外在其基础上，扩展了多种语法和交互：
1. 生成步骤式导航
使用 # 来标记为页面标题
使用 ## 来标记为章节标题，章节标题会在右侧显示为浮动导航
输入：
# Page Title~
## Try It Online
## Download and install
## File Structure
## What next?输出：
2. 漂亮的链接块
输入：
:::link-group
[Android](https://www.android.com/)
[iOS](https://www.apple.com/)
[Vue](https://vuejs.org/)
:::输出：
3. 标签导航栏
输入：
:::tab
### 即时通信 IM
hi. IM
---
### 音视频 TRTC
hi. trtc~
---
### 联络中心 TCCC
hi. tccc~
:::输出：
hi. IM
hi. trtc~
hi. tccc~
4. 在代码块中实现行高亮
输入：
```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```输出：
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}除了单行之外，还可以指定多个单行、多行，或两者均指定：
- 多行：例如
{5-8}、{3-10}、{10-17} - 多个单行：例如
{4,7,9} - 多行与单行：例如
{4,7-13,16,23-27,40}
代码块中的颜色差异
在某一行添加 // [!code --] 或 // [!code ++] 注释将会为该行创建 diff，同时保留代码块的颜色。
输入：
```js
export default {
data () {
return {
msg: 'Removed' // [!!code --]
msg: 'Added' // [!!code ++]
}
}
}
```输出：
export default {
data () {
return {
msg: 'Removed'
msg: 'Added'
}
}
}高亮“错误”和“警告”
在某一行添加 // [!code warning] 或 // [!code error] 注释将会为该行相应的着色。
输入：
```js
export default {
data () {
return {
msg: 'Error', // [!!code error]
msg: 'Warning' // [!!code warning]
}
}
}
```输出：
export default {
data() {
return {
msg: 'Error',
msg: 'Warning'
};
}
};5. 预览代码执行结果
（先欠着 🥹🥹）
部署
（待补充，欠债欠债 ٩(•̤̀ᵕ•̤́๑)ᵒᵏᵎᵎᵎᵎ）
（待补充，欠债欠债 ٩(•̤̀ᵕ•̤́๑)ᵒᵏᵎᵎᵎᵎ）
（待补充，欠债欠债 ٩(•̤̀ᵕ•̤́๑)ᵒᵏᵎᵎᵎᵎ）
（待补充，欠债欠债 ٩(•̤̀ᵕ•̤́๑)ᵒᵏᵎᵎᵎᵎ）
（待补充，欠债欠债 ٩(•̤̀ᵕ•̤́๑)ᵒᵏᵎᵎᵎᵎ）