MarkDown一般用法说明

2017-09-07 本文已影响0人 rockee阿木

MarkDown一般用法说明

markdown是简单的标记性文本语言，特别是近几年开源运动的兴起后，markdown已经在事实上成为技术开发人员在开发文档、手册、帮助、技术博客等书写中的通用文档格式，这里主要介绍markdown语法的一些一般用法。

主要优点 ：轻量级的标记性语言，可版本控制，编辑器平台无关，导出html,pdf方便。
主要缺点 ：表现形式不够丰富, 不能复杂布局，不能多人编辑，不可批注，无法代替办公文档

<span id="content_index">本文目录

标题与列表
分隔符、换行、斜体、粗体、删除线
单行引用与代码引用
链接与锚点
图片与表格
复杂图表
markdown编辑器
参考补充
一个例子

<span id="1.1">标题与列表

标题：MD中标题共有6级
<table border="0">
<tr><th>书写格式</th><th>表现形式</th></tr>
<tr><td># 一级标题</td><td><h1>一级标题</h1></td></tr>
<tr><td>## 二级标题</td><td><h2>二级标题</h1></td></tr>
<tr><td>### 三级标题</td><td><h3>三级标题</h1></td></tr>
<tr><td>#### 四级标题</td><td><h4>四级标题</h1></td></tr>
<tr><td>##### 五级标题</td><td><h5>五级标题</h1></td></tr>
<tr><td>###### 六级标题</td><td><h6>六级标题</h1></td></tr>
</table>

有序列: 一般用于描述流程，如编译、发布、安装、更新、维护产品的步骤

格式：数字+英文句号'.'+空格符号

下载软件demo-0.0.1a.tar.gz
解压到/tmp目录下
在shell下运行./configure --prefix=/opt/demo
运行make install
配置/etc/demo/d.conf

无序列: 一般用于没有前后关系的任务、功能的分解、罗列。如需求分析、架构组织、问题罗列

格式：'*|-|+'+空格符号

unorder.png

unorder02.png

<span id="1.2">分隔符、换行、斜体、粗体、删除线

分隔符: 分割段落

格式：三个'*', 三个'-',三个'_'

换行:

格式：行末追加两空格符

粗体：格式**粗体字**，粗体字
斜体：格式*斜体字*，斜体字
删除线：格式~~删除这里~~ ~~删除这里~~

<span id="1.3">单行引用与代码引用

引用: 如用于说明指令，命令行

$ ./configure --prefix=/opt/wlan/nginx/soft/nginx --with-pcre=/opt/wlan/nginx/pcre-8.10 --with-http_stub_status_module --with-openssl --without-ipv6

代码: 代码片段的展现，api调用实例

c代码的引用

/*
author: ddmer
date: 2017-09-02
*/
static char author[] = "ddmer";
static char version[] = "0.0.2";

int main(){
  printf("app ver: %s\n", version);
  return 0;
}

lua代码的引用

-- 这是一段lua程序
local VERSION = "0.0.1a";
local function make_resuponse(session, url, status)
    local msg = string.format("successful %d", status);
    local json = make_json(msg, status);
    session.send(json);
end

js代码的引用

/*  
程序功能，定义一个函数，用于显示Hello World  
*/  
function sayHello(){  
    //在HTML文档中显示hello  
    document.write("Hello World");  
}  
sayHello();

<span id="1.4">链接与锚点

链接：用于指向有关联的文档或者三方的文档参考

內联式：[caption](URL "optional title")

例如：[Apple中国](https://www.apple.com/cn/ "苹果") Apple中国

参考式：caption

例如：

成都市2017年商品房销售超1500亿 [2017上半年统计][1]  
[1]: http://sichuan.scol.com.cn/cddt/201707/55956473.html

成都市2017年商品房销售超1500亿 [2017上半年统计][1]
[1]: http://sichuan.scol.com.cn/cddt/201707/55956473.html

锚点：用于页面内的跳转，快速定位，检索(部分编辑器支持)

格式：

[caption](#jump_label)
  ...
  ...
<span id="jump_label">

例如:

[返回目录](#content_index)

返回目录

<span id="1.5">图片与表格

图片

格式:
相对路径
![](/path/image.png "title")
绝对路径
![](URL "title")

例如：

![](./md_comm/gg_logo.png "google")

gg_logo.png

表格

格式:

| 商品      |    价格 | 质量  |
| :------- | -- ---:| :---: |
| 个人电脑  | 1600 ¥ |  5   |
| 手机      |   12 ¥ |  12  |
| 线缆      |    1 ¥ | 234  |

商品	价格	质量
个人电脑	1600 ¥	5
手机	12 ¥	12
线缆	1 ¥	234

<span id="1.6">复杂图表公式

复杂的图表公式不是markdown的标准功能，更多的是一些编辑器的特色

公式

math_formula.png
流程图

flow.png
甘特图

gantt.png
时序图

sequence.png

<span id="1.7">MarkDown编辑器

● 支持离线编辑
○ 支持在线编辑

功能支持	sublime	有道笔记	马克飞象	Cmd Markdown	segment	简书	github
在线离线	●	● ○	● ○	● ○	○	○	○
内嵌html	✓		✓	✓
标题	✓	✓	✓	✓	✓	✓	✓
列表	✓	✓	✓	✓	✓	✓	✓
分隔符	✓	✓	✓	✓	✓	✓	✓
换行	✓	✓	✓	✓	✓	✓	✓
粗体、斜体	✓	✓	✓	✓	✓	✓	✓
删除线		✓	✓	✓	✓	✓	✓
引用、代码	✓	✓	✓	✓	✓	✓	✓
链接	✓	✓	✓	✓	✓	✓	✓
图片	✓	✓	✓	✓	✓	✓	✓
表格	✓	✓	✓	✓	✓	✓	✓
锚点	✓		✓	✓			✓
LaTeX公式			✓	✓
流程图		✓	✓	✓
甘特图		✓	✓	✓
顺序图		✓	✓	✓

<span id="1.8">参考补充

Markdown: Syntax
Markdown 语法说明 (简体中文版)
Markdown快速入门
 为什么我们要学习 Markdown 的三个理由
 Markdown: 指南

<span id="1.9">一个例子

一个虚构的产品：聚天眼（网络探针）说明文档

markdown代码


聚天眼（网络探针）
======
聚天眼（网络探针）是公司研发的新一代网络安全监控产品，已通过国家信息安全测评中心权威测评, 授权产品编号 **网信SN2017C0027**，并获得国家发明专利1项，软件著作权2项，获得西原省2018科技进步二等奖。主要用于数据敏感，对安全等级有较高要求的政府企事业单位，对内网监控，服务器网络监控，重点区域网络监控，流量监控，提供7x24小时不中断服务，提供预设的应急处置方案及实时管控机制。


产品特点
-------
| 功能特点 | 聚天眼   | 可里网控 | 腾马网盾 | 天盾365 |
|---------|:-------:|:-------:|:-------:|:--------:|
| 可冗余   |    ✓   |    ✓    |    ✓    |     ✓    |
| 智能预警 |    ✓   |    ✓    |         |          |
| 热更新   |    ✓   |         |    ✓    |          |
| 无线监控 |    ✓   |    ✓    |         |     ✓    |
| 应急方案 |    ✓   |         |    ✓    |     ✓    |


安装与部署流程
------------
1. 硬件设备接入到监控网络总入口
2. 插入USB管理key，启动设备
3. 登录并配置正版授权证书
5. PC上安装监控平台系统
5. 配置管理员账号
6. 设定管控信息及应急处置方案
7. 拔出USB管理key
8. 部署完成

维护与热更新步骤
--------------
1. 设备插入USB管理key
2. 在监控平台进入维护升级界面
3. 预设维护升级时间，指定升级文件
4. 拔出USB管理key

预设维护配置文件格式
-----------------
\```json
{
  "date": "2017-09-20 02:00:00",
  "bin": "/tmp/update/j-net1.0.3a.img",
  "mode": "silence"
}
\```

更多信息
-------
[聚天眼: 安装指南](https://www.j-tek.com/j-net-eye/2016/install)  
[聚天眼: 维护升级手册](https://www.j-tek.com/j-net-eye/2016/maintenance)  
[聚天眼: 购买指南](https://www.j-tek.com/j-net-eye/2016/buy)

聚天眼（网络探针）

聚天眼（网络探针）是公司研发的新一代网络安全监控产品，已通过国家信息安全测评中心权威测评, 授权产品编号 网信SN2017C0027，并获得国家发明专利1项，软件著作权2项，获得西原省2018科技进步二等奖。主要用于数据敏感，对安全等级有较高要求的政府企事业单位，对内网监控，服务器网络监控，重点区域网络监控，流量监控，提供7x24小时不中断服务，提供预设的应急处置方案及实时管控机制。

产品特点

功能特点	聚天眼	可里网控	腾马网盾	天盾365
可冗余	✓	✓	✓	✓
智能预警	✓	✓
热更新	✓		✓
无线监控	✓	✓		✓
应急方案	✓		✓	✓

安装与部署流程

硬件设备接入到监控网络总入口
插入USB管理key，启动设备
登录并配置正版授权证书
PC上安装监控平台系统
配置管理员账号
设定管控信息及应急处置方案
拔出USB管理key
部署完成

维护与热更新步骤

设备插入USB管理key
在监控平台进入维护升级界面
预设维护升级时间，指定升级文件
拔出USB管理key

预设维护配置文件格式

{
  "date": "2017-09-20 02:00:00",
  "bin": "/tmp/update/j-net1.0.3a.img",
  "mode": "silence"
}

MarkDown一般用法说明

MarkDown一般用法说明

<span id="1.1">标题与列表

unorder.png

<span id="1.2">分隔符、换行、斜体、粗体、删除线

<span id="1.3">单行引用与代码引用

<span id="1.4">链接与锚点

<span id="1.5">图片与表格

<span id="1.6">复杂图表公式

<span id="1.7">MarkDown编辑器

<span id="1.8">参考补充

<span id="1.9">一个例子

聚天眼（网络探针）

产品特点

安装与部署流程

维护与热更新步骤

预设维护配置文件格式

更多信息

猜你喜欢

热点阅读