How to use Markdown to write technical documents
Markdown常用语法
[TOC]
基本用法
粗体
删除线
下划线
创建脚注[^脚注]
- 事物
- 事物的定义
- 代码块定义
- 代码块定义……
var a = 10; // 保持空一行与 递进缩进
开头一个: + Tab 或 四个空格
字体
face : 字体样式
华文彩云color : 可以用十六位颜色值，也可以用已知颜色名
标红字体size : 规定文本尺寸大小,可能值从 1~7，浏览器默认值为 3
1号尺寸背景色
| 背景色是：orange |
格式化文本
保持输入排版格式不变
hello world
hi
hello world
其他特殊字符
代码 显示结果 ❤ ❤ ✓ ✓ ☀ ☀ ★ ★ ❄ ❄ ✓ ☂ ☢ ☢ ☎ ☎ ♫ ♫ ∞ ∞
锚点
插入锚点: {#index} 跳转锚点: 描述
emoji表情符号
:smile: :smiley: :worried:
多选项
- 选项一
- 选项二
链接
高级链接, 这个链接用1作为网址变量 ggangliu.cn
图片
表格
| 表头 | 表头 |
|---|---|
| 单元格 | 单元格 |
| 单元格 | 单元格 |
| AAA | BBB | |
|---|---|---|
| CCC | ||
| DDD | ||
高级技巧
不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写
- 使用 Ctrl+Alt+Del 重启电脑
- ** 正常显示星号 **
-
公式 Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式
$...$ 或者 \(...\) 中的数学表达式将会在行内显示 $$...$$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示$ f(x) = sin(x) + 12 $
\[\sum_{n=1}^{100}\] \[\begin{Bmatrix} a & b \\ c & d \end{Bmatrix}\] \[\begin{CD} A @>a>> B \\ @VbVV @AAcA \\ C @= D \end{CD}\] - 饼图
%%{init: {'theme': 'base', 'themeVariables': { 'pie1': '#00FF00', 'pie2': '#FFFF00', 'pie3': '#ff0000', 'pie4': '#0000FF', 'pie5': '#800080', 'pie6': '#ff0000', 'pie7': '#FFA500'}}}%%
pie
title 为什么总是宅在家里？
"喜欢宅" : 15
"天气太热或太冷" : 20
"穷" : 50
- 甘特图
任务状态 done 已完成 active 正在进行 crit 关键任务
任务描述 在des1、des2位置添加任务描述，其它任务引用时直接引用des1就可以。
after 描述任务时间关系。des3, after des2表示des3紧跟在des2之后
任务时长有三种方式 时间范围 如：2014-01-06,2014-01-08 指定天数 如：5d 指定开始日期+天数 如：2014-01-06，5d
gantt
dateFormat YYYY-MM-DD
title 软件开发甘特图
section 设计
需求 :done, des1, 2014-01-06,2014-01-08
原型 :active, des2, after des1, 3d
UI设计 :des3, after des2, 5d
未来任务 :des4, after des3, 5d
section 开发
学习准备理解需求 :crit, done, 2014-01-06, 24h
设计框架 :crit, done, after des2, 2d
开发 :crit, active, 3d
未来任务 :crit, 5d
耍 :2d
section 测试
功能测试 :active, a1, after des3, 3d
压力测试 :after a1 , 20h
测试报告 : 48h
备注块
[!NOTE] [!TIP] [!IMPORTANT] [!CAUTION] [!WARNING] [!ADMINISTRATION] [!AVAILABILITY] [!PREREQUISITES] [!ERROR] [!INFO] [!SUCCESS]