Markdown 语法介绍

from:https://coding.net/help/doc/project/markdown.html

文章内容

  • 1 Markdown 语法介绍

    • 1.1 标题
    • 1.2 锚点
    • 1.3 引用
    • 1.4 列表
    • 1.5 代码
    • 1.6 强调
    • 1.7 自动链接
    • 1.8 表格
    • 1.9 分割线
    • 1.10 图片
    • 1.11 流程图
    • 1.12 时序图
    • 1.13 甘特图

Markdown 语法介绍

Markdown 是一种轻量级标记语言,让写作者专注于写作而不用关注样式。Coding 的许多版块均采用了 Markdown 语法,比如冒泡、讨论、Pull Request 等。

标题

用 Markdown 书写时,只需要在文本前面加上『# 』即可创建一级标题。同理,创建二级标题、三级标题等只需要增加『# 』个数即可,Markdown 共支持六级标题。如下所示:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

点击预览可以看到效果:

锚点

Coding 会针对每个标题,在解析时都会添加锚点 id,如

# 锚点

会被解析成:

<h1 id="user-content-锚点">锚点</h1> 

注意我们添加了一个 user-content- 的前缀,所以如果要自己添加跳转链接要使用 Markdown 的形式,且链接要加一个 user-content- 前缀,如:

[访问链接](#user-content-锚点);

引用

Markdown 标记区块引用和 email 中用 『>』的引用方式类似,只需要在整个段落的第一行最前面加上 『>』 :

> Coding.net 为软件开发者提供基于云计算技术的软件开发平台,包括项目管理,代码托管,运行空间和质量控制等等。

效果图如下:

区块引用可以嵌套,只要根据层次加上不同数量的『>』:

> 这是第一级引用。
>
> > 这是第二级引用。
>
> 现在回到第一级引用。

效果图如下:

引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等:

> ## 这是一个标题。
> 1. 这是第一行列表项。
> 2. 这是第二行列表项。
>
> 给出一些例子代码:
>
> return shell_exec(`echo $input | $markdown_script`);

效果图如下:

列表

列表项目标记通常放在最左边,项目标记后面要接一个字符的空格。

无序列表:使用星号、加号或是减号作为列表标记

- Red
- Green
- Blue

效果图如下:

有序列表:使用数字接着一个英文句点

1. Red
2. Green
3. Blue

效果图如下:

如果要在列表项目内放进引用,那『>』就需要缩进:

*  Coding.net有以下主要功能:
    > 代码托管平台
    > 在线运行环境
    > 代码质量监控
    > 项目管理平台

效果图如下:

代办列表: 表示列表是否勾选状态(注意:[ ] 前后都要有空格)

- [ ] 不勾选
- [x] 勾选

效果图如下:

代码

只要把你的代码块包裹在 “` 之间,你就不需要通过无休止的缩进来标记代码块了。 在围栏式代码块中,你可以指定一个可选的语言标识符,然后我们就可以为它启用语法着色了。 举个例子,这样可以为一段 Ruby 代码着色:

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

效果图如下:

强调

在Markdown中,可以使用 * 和  _  来表示斜体和加粗。

斜体

*Coding,让开发更简单*
_Coding,让开发更简单_

效果图如下:

加粗

**Coding,让开发更简单**
__Coding,让开发更简单__

效果图如下:

自动链接

方括号显示说明,圆括号内显示网址, Markdown 会自动把它转成链接,例如:

[超强大的云开发平台Coding](http://coding.net)

效果图如下:

表格

在 Markdown 中,可以制作表格,例如:

First Header | Second Header | Third Header
------------ | ------------- | ------------
Content Cell | Content Cell  | Content Cell Content Cell | Content Cell | Content Cell 

效果图如下:

或者也可以让表格两边内容对齐,中间内容居中,例如:

First Header | Second Header | Third Header
:----------- | :-----------: | -----------:
Left         | Center        | Right
Left         | Center        | Right

效果图如下:

分割线

在 Markdown 中,可以使用 3 个以上『-』符号制作分割线,例如:

这是分隔线上部分内容
---
这是分隔线上部分内容

效果图如下:

图片

Markdown 使用了类似链接的语法来插入图片, 包含两种形式: 内联 和 引用.

内联图片语法如下:

![Alt text](/path/to/img.jpg)
或
![Alt text](/path/to/img.jpg "Optional title")

也就是:

  • 一个惊叹号『!』
  • 接着一个方括号,里面是图片的替代文字
  • 接着一个普通括号,里面是图片的网址,最后还可以用引号包住并加上 选择性的『title’』文字。

引用图片语法如下:

![Alt text][id]

『id』 是图片引用的名称. 图片引用使用链接定义的相同语法:

[id]: url/to/image "Optional title attribute"

流程图

Markdown 编辑器已支持绘制流程图、时序图和甘特图。通过 mermaid 实现图形的插入,点击查看 更多语法详情。

```graph
graph TD;A-->B;A-->C;B-->D;C-->E;E-->F;D-->F;F-->G;
```

效果图如下:

时序图

```graph
sequenceDiagramparticipant Aliceparticipant BobAlice->John: Hello John, how are you?loop HealthcheckJohn->John: Fight against hypochondriaendNote right of John: Rational thoughts
prevail...John-->Alice: Great!John->Bob: How about you?Bob-->John: Jolly good!
```

效果图如下:

甘特图

```graph
ganttdateFormat  YYYY-MM-DDtitle Adding GANTT diagram functionality to mermaidsection A sectionCompleted task            :done,    des1, 2014-01-06,2014-01-08Active task               :active,  des2, 2014-01-09, 3dFuture task               :         des3, after des2, 5dFuture task2               :         des4, after des3, 5dsection Critical tasksCompleted task in the critical line :crit, done, 2014-01-06,24hImplement parser and jison          :crit, done, after des1, 2dCreate tests for parser             :crit, active, 3dFuture task in critical line        :crit, 5dCreate tests for renderer           :2dAdd to mermaid                      :1d
```

效果图如下:

转载于:https://www.cnblogs.com/bonelee/p/10834536.html

Markdown 语法介绍相关推荐

  1. Markdown语法介绍

    导航目录 简介 语法 1.标题 2.列表 1)无序列表(*,+,-) 2)有序列表(数字+点号) 3.文字样式 1)粗体,斜体,粗体+斜体 2)删除 3)突出标记 4)下划线 5)字体大小 6)字体颜 ...

  2. markdown语法大全_Markdown超详细介绍

    一.什么是 Markdown Markdown 是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式. 二.markdown下载和使用 1. 客户端 我使 ...

  3. html嵌入式的脚本语言,Markdown语法及html内嵌

    之前看到很多大佬博客写的特别漂亮,非常羡慕,他们是怎么排版的呢?作为一个小白,学习使我快乐....终于在不断摸索中,找到方法.原来大佬们使用了一个新的语言--Markdown. 1.Markdown介 ...

  4. 半小时学会Markdown语法,让你从快速入门到熟练掌握typora编辑器,大家记笔记写讲义都在用。

    文章目录 Markdown简介 Markdown主要应用 Markdown编辑器 Typroa编辑器 Markdown语法 Markdown 标题 Markdown 段落 字体 分隔线 删除线 下划线 ...

  5. 【超用心整理】Markdown常用语法介绍,看这一个就够了

    Markdown常用语法介绍 Markdown是一种使用一定的语法将普通的文本转换成HTML标签文本的编辑语言,它的特点是可以使用普通的文本编辑器来编写,只需要按照特定的语法标记就可以得到丰富多样的H ...

  6. 国产的markdown 语法的思维导图和大纲工具!

    MarkMind 简介 MarkMind 是一款支持markdown语法的思维导图和大纲工具,主要特色就是在节点内部直接支持markdown语法. Markdown是一种纯文本格式的标记语言.通过简单 ...

  7. 入门写博客之markdown语法

    目录 1. 快捷键 2. 基本语法 2.1 字体设置斜体.粗体.删除线 2.2 分级标题 2.3 链接 2.4 分割线 2.5 代码块 2.6 引用 2.7 列表 2.8 表格 3. 常用技巧 3.1 ...

  8. activiti高亮显示图片_第 09 篇:让博客支持 Markdown 语法和代码高亮

    作者:HelloGitHub-追梦人物 文中涉及的示例代码,已同步更新到HelloGitHub-Team 仓库[1] 为了让博客文章具有良好的排版,显示更加丰富的格式,我们使用 Markdown 语法 ...

  9. 书写README的各种markdown语法

    README 该文件用来测试和展示书写README的各种markdown语法.GitHub的markdown语法在标准的markdown语法基础上做了扩充,称之为GitHub Flavored Mar ...

最新文章

  1. Oracle round函数是什么意思?怎么运用?
  2. 笔记 | PyTorch张量Tensor的一些必备操作
  3. 最佳置换算法(OPT)
  4. 37、iamgeview 图层叠加
  5. 实现CheckboxGroup的全部选中
  6. IT项目管理总结:第二章 项目管理和IT背景
  7. Cocos2d-x 寻路算法解析(二): 离目的地的距离优先
  8. 树莓派该文件名_树莓派:文本编辑器与文件
  9. myeclipse ctrl + 鼠标单击 出现 source not found
  10. Win10虚拟机性能优化
  11. UWB三维定位方式概述
  12. 大学计算机实践教程raptor,大学计算机实践教程.docx
  13. Rack集成Sentry
  14. 做笔记的方法—— 推荐笔记方法Word方式
  15. MySQL 语法整理(2)
  16. excel将柱状图的柱宽减为直线的方法 作x轴垂线的方法
  17. 「UG/NX」NX2212手动安装方法教程
  18. 富文本编辑器CKEditor 5的使用
  19. SUPPORTED TYPESCRIPT VERSIONS: >=3.3.1 <4.5.0
  20. 终于搞清楚了,关于核心线程会不会回收

热门文章

  1. react http请求_通过Webpack全局配置开发环境和多种生产环境的请求地址
  2. 如何在Eclipse中添加新建包,java文件,工程工具栏按钮
  3. 容易被误会的 Kafka 消费者属性 enable.auto.commit
  4. win10 系统怎么获取最高管理员权限删除文件
  5. eax ax ah al
  6. ud分区删除工具_如何用DiskGenius对硬盘进行分区
  7. proc除了能用于oracle开发_能不能用于mysql开发_Oracle数据库开发(二).Linux下配置使用ProC...
  8. mysql myisam转innodb_Mysql MyISAM数据库批量转换表引擎为Innodb
  9. 企业研发人员配备比例_企业管理人员合理配置比例
  10. python中求和公式是什么函数_Python的math库中,用于求和的函数是( )。