sand
贫民
贫民
  • 最后登录2018-12-27
  • 发帖数1
阅读:7481回复:1

markdown文档编写

楼主#
更多 发布于:2018-11-09 15:45
markdown文档编写优缺点
markdown是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内容具有一定的格式。
优点:
1、因为是纯文本,所以只要支持markdown的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰,专心写作。
2、操作简单。

缺点:
1、需要记一些语法(很简单)。
2、有些平台不支持markdown编辑模式。

markdown基本语法
一、标题
在想要设置为标题的文字前面加#来表示
一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

例:
# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题
二、字体 / 分割线
加粗
要加粗的文字左右分别用两个*号包起来
斜体
要倾斜的文字左右分别用一个*号包起来
斜体加粗
要倾斜和加粗的文字左右分别用三个*号包起来
删除线
要加删除线的文字左右分别用两个~~号包起来
例:
**这是加粗的文字**
*这是倾斜的文字*`
***这是斜体加粗的文字***
~~这是加删除线的文字~~
分割线语法:
可以在一行中用三个及以上的星号、减号、等于号、底线来建立分隔线,行内不能有除空格外的其他东西。
例:
***
---
===
___
三、图片 / 超链接
图片语法:
![图片text](图片地址 ''图片title'')
图片text 就是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。(title按需添加)。
例:
![首页图片](、demo/public/home.jpg "首页")
超链接语法:
[超链接名](超链接地址 "超链接title")
title可加可不加
例:
[百度](http://baidu.com)
四、表格
表格一般这样子写,这应该是最简单的写法了
id | name | score
--- | --- | ---
001 | Mark | 90
002 | Ford | 80
003 | Alan | 95
还有就是对齐了,用:对齐,:写在在---的左边就是左对齐,右边就是右对齐,两边都写就是居中。

|long_long_id|long_long_name|long_long_score|
| --- | :---: | ---: |
| 001 | Mark | 90 |
| 002 | Ford | 80 |
| 003 | Alan | 95 |

五、列表
无序列表
可以在每行开头用星号、加号、减号来表示,也可以三者混合一起,推荐使用相同的字符,避免混乱。
例:
* 一
* 两
* 三
有序列表
用数字接着一个英文句点来表示,数字可无序,但还是推荐使用1.2.,避免混乱。
例:
1. 一
2. 两
3. 三
六、目录
直接添加 [TOC],标题1~6样式的内容会被提取出来作为目录,然而有些编辑器不能使用这功能,如 Mou 不能使用。
例:
[TOC]
# 标题一
……
## 标题二
……
### 标题三


七、结合HTML标签书写

需要使用 `{% verbitam %} {% endverbatim %}`标签包裹起来
例:
{% verbatim %}
<table>
<tbody>
<tr>
<td>串接系统保护切换</td>
<td>串接系统主备切换</td>
<td>串接系统数据分流/保护/复制</td>
</tr>
</tbody>
</table>

{% endverbatim %}


八、代码片段

代码块用```符号包裹起来,单行代码也可用`包裹起来



!!!更多效果和语法可自行百度


doubleyong
管理员
管理员
  • 最后登录2026-05-10
  • 发帖数1198
  • 最爱沙发
  • 喜欢达人
  • 原创写手
  • 社区居民
  • 忠实会员
沙发#
发布于:2018-11-10 15:40
这个酷哦
知识需要管理,知识需要分享
游客


返回顶部

公众号

公众号