markdown快速入门

网友投稿 684 2022-05-29

markdown是什么

markdown是一种轻量级的标记语言,能够帮助纯文本的文档增强易读性,并且当前很多软件都支持渲染markdown,通过markdown的渲染可以生成很好看的文档。本文讲解markdown的基本语法帮助读者快速入门

markdown基本 语法

标题

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

正文

普通正文,直接输入即可;

背景灰,灰色背景示例;

`灰色背景示例`

斜体,斜体;

*斜体*

强调,强调;

*强调*

表格

|col1|col| |----|---| |col1|col| |col1|col|

效果如下:

超链接

格式:

[文字](url)

如:

[官网](https://www.baidu.com)

效果:

官网

图片

格式:

[alt](url_or_path)

如:

markdown快速入门

[alt](assets/2017-08-21-21-00-25.png)

效果:

mermaid

mermaid 可以在markdown内渲染出流程图、顺序图、类图、状态图、实体关系图等图形。

流程图

使用mermaid需要把代码用如下字符串包含:

简单mermaid图代码

效果如下:

A

B

C

D

d

从上到下代码如下:

效果如下:

A

B

C

D

d

节点的形状

椭圆形id1([This is the text in the box])

This is the text in the box

不知道啥形状id1[[This is the text in the box]]

This is the text in the box

数据库形状

Database

圆形

This is the text in the circle

连线

箭头-->

A

B

直线A---B

A

B

直线+文字A--- 文字 ---B

A

文字

B

时序图

participant 定义时序图的item

->>表示通讯连线

-->>表示虚线连线

冒号后面的是连线中间的文字

类图

classDiagram 定义类类图

Animal <|-- DuckDuck继承Animal

Animal : +int ageAnimal声明一个public属性age

Animal: +isMammal()Anima声明一个public方法isMammal

class Fish声明一个Fish class

其他参考

mermaid参考:https://mermaidjs.github.io/demos.html

如果想更深层次的学习markdown 可关注该网址。

Markdown

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:【SparkAPI JAVA版】JavaPairRDD——countByValue、countByValueApprox
下一篇:Python pandas模块输出每行中间省略号问题
相关文章