关于
MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用。
可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。
本doc支持常用快捷键如Ctrl+c,了解更多快捷键请在编辑时查看编辑页面右上角的使用帮助
文本格式
Size:规定文本的尺寸大小。可能的值:从 1 到 7 的数字。浏览器默认值是 3。
<font face="STCAIYUN">我是华文彩云</font>
<font color=gray size=5>color=gray</font>
<font color=#0099ff size=5 face="黑体">color=#0099ff size=5 face="黑体"</font>
效果:
我是华文彩云
color=gray
color=#0099ff size=5 face=”黑体”
背景色
<table><tr><td bgcolor=#FF4500>这里的背景色是:OrangeRed, 十六进制颜色值:#FF4500, rgb(255, 69, 0)</td></tr></table>
效果:
这里的背景色是:OrangeRed, 十六进制颜色值:#FF4500, rgb(255, 69, 0) |
呈现效果如下
这里的背景色是:OrangeRed, 十六进制颜色值:#FF4500, rgb(255, 69, 0)
列表
无序列表
语法:
无序列表用 - + * 任何一种都可以
- 列表内容
+ 列表内容
* 列表内容
效果:
- 列表内容
- 列表内容
- 列表内容
注意:- + * 跟内容之间都要有一个空格
有序列表
语法:数字加点
- 列表内容
- 列表内容
- 列表内容
注意:序号跟内容之间要有空格
任务列表
用- [ ]
来做未完成的计划列表,用- [x]
作为完成的;下级在前面加Tab键
即可。
示例:
- [ ] 历史记录再计算
- [x] 小程序
- [x] 历史查询
- [ ] 充值
效果
- 历史记录再计算
- 小程序
- 历史查询
- 充值
表格
语法:
表头|表头|表头
--|:--:|---:
内容|内容|内容
内容|内容|内容
第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右
注:原生的语法两边都要用 | 包起来。此处省略
示例:
这里要空一行
姓名|技能|排行
--:|:--:|--:
刘备|哭|大哥
关羽|打|二哥
张飞|骂|三弟
效果:注意前后要空行才行
姓名 | 技能 | 排行 |
---|---|---|
刘备 | 哭 | 大哥 |
关羽 | 打 | 二哥 |
张飞 | 骂 | 三弟 |
顶部加上导航目录
语法
[TOC]
//这里要空一行
效果:
折叠内容
写法:
<details> <summary>点击展开</summary>
code ...这里是内容
各种内容
</details>
效果:
点击展开
code …这里是内容
各种内容
文档内跳转
在需要跳转到的位置处添加跳转点
<a name="guanyu"></a>
在需要跳转的地方添加跳转链接
[关于](#guanyu)
效果:跳转到关于
注意:小括号内的自定义标签不能为中文
多级导航目录
理论上 MinDoc支持无限级的文档创建。
在 MinDoc 中没有目录概念,所有文档既是目录也是文档。默认情况下,点击左上角加号即可创建顶级文档:
如果想创建一个文档的下一级项目,可直接在项目上右键,即可弹出创建菜单:
同样,还可以通过右键菜单修改以及删除文档。
修改默认的封面
MinDoc 在创建项目时会通过浏览器的H5绘图接口生成一个默认的封面。
用户还可以在项目设置中修改项目封面:
- 第一步 打开我的项目
- 第二步 点击设置按钮
- 第三步 切换到项目设置
- 点击右侧项目图片,即可上传自定义封面
引用
>我是默认引用
我是默认引用
>[info] 我是INFO类型引用
我是INFO类型引用
>[warning] 我是warning类型引用
我是warning类型引用
>[success] 我是success类型引用
我是success类型引用
>[danger] 我是danger类型引用
我是danger类型引用
最后编辑:admin 更新时间:2024-10-21 00:06