.md即markdown文件常用语法

article/2025/10/12 8:47:34

参阅cmd版官网:markdown

参考博文:Markdown语法介绍(详细)

1.标题

使用#符号包起来,符号和内容中间空格可省略,尾部#号可省略。依次1~6级标题,对应html中的h1~6标签

=会使上一行成为一级标题,-上一行二级标题,—若要设为分隔符,则要换行再—

# 一级标题1
一级标题2
===
## 二级标题1
二级标题2
---
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

一级标题1

一级标题2

二级标题1

二级标题2

三级标题

四级标题

五级标题
六级标题

2.字体

*包起来为斜体,**加粗,==高亮(这里idea未生效),和内容之间都不能有空格。这些都是行内块元素,不自动换行。

*斜体***加粗**~~删除线~~[//]: # (注释:idea这里高亮未生效)
==高亮==<mark>高亮</mark><m>高亮</m>***加粗斜体***

斜体

加粗

删除线

高亮

高亮

高亮

加粗斜体

3.引用内容

以>开头的内容为引用,可嵌套

三个及以上***/===为分割线

``嵌套为单行代码,```代码```为多行代码,idea这里单行也能实现。\为转义字符用法同代码语法。、

第一行```后接编程语言名,可根据对应语言的语言显示不同颜色,编辑器也会验证其中语法

[//]: # (注释内容),idea Ctrl+/ 别的地方注释好像不是这个。

没法反引号嵌套这里贴图



引用

代码hello world

//多行代码
if(true){//1
}else{//2
}
//这里使用的JavaScript语言
let n=1;
n++;
console.log(n);

4.列表

*或+或-开头接空格接内容的为无序列表,(n)(空格)开头的为有序列表,下一级列表在下一行多缩进即可。

  • 一级无序列表1.1
    • 二级无序列表2.1
      • 三级无序列表3.1
      • 三级无序列表3.2
      • 三级无序列表3.3
      • 三级无序列表3.4
  1. 一级有序列表1.1
  2. 一级有序列表1.2
    1. 二级有序列表2.1
    2. 二级有序列表2.2
      1. 三级有序列表
      2. 三级及以后序号为abc

5.链接

超链接,[显示内容](路径),有说路径可用[]括起来,idea和csdn无效,Typora有效

百度一下

[百度一下][http://www.baidu.com/]

链接也可跳转锚点,由于.md可使用html标签,标签id即可作为锚点,[显示内容](#id),直接#无法作为锚点

<span id="top">参阅cmd版官网:</span>	/**顶部的内容*/
[回到顶部](#top)							/**下面内容的代码*/

回到顶部

图片,idea可以正常用html语法,有width、height、src、title、alt属性

<img src="./test.png" alt="图片走丢">
图片走丢

*![title]*(路径),idea能用,但图片丢失时title为中文时无法显示

![hello](./test.png)csdn找不到图片显示一长串,这里就不放出来了

[title]: 路径在idea中无效

这里发现了一个问题,首先想在引用中显示英文中括号[],填入内容,则被判定为代码,于是使用[就会这样],转义字符无效。只好再**包起来。(后来发现别人都用``括起来)

由此发现:使用[变量名]:路径,相当于命名变量,在本文中任意地方使用*![变量名]* 即可显示该图片。

同理:*[变量名]*即可显示链接

*[abc]**![abc]*[abc]: http://www.baidu.com

abc

abc

6.表格

|代表左右边框,左右外边框可略,idea会警告,仍能显示。

|—|—|区分表头表身,:代表当前列对齐方式,无tfoot,无法合并td。不可\t开头

|                    -----------标题 | 内容----------------- |
|----------------------------------:|:------------------------|
|                              标题1 | 标题2                     |
|                              标题2 | 内容2                     |
-----------标题内容-----------------
标题1标题2
标题2内容2

7.表单

-[ ] 表示未选中勾选框
-[x] 表示选中勾选框

  • 选项一
  • 选项二

8.数学公式

这个要额外配置LaTeX之类的

cmd版本,\sum代表^后的内容接次幂,若∑则在其上,_后的内容为下标,~~包起来内容为下标,若则在其下,若式子则用{}括起来

$括起来在行内,行内块元素,$$括起来则独占一行,行内元素

以下内容在idea无效,cmd、csdn都能显示公式

$$E=mc^2$$$$\sum_{i=1}^n a_i=0$$

E = m c 2 E=mc^2 E=mc2

∑ i = 1 n a i = 0 \sum_{i=1}^n a_i=0 i=1nai=0

9.html相关

每个版本md文件读取语法各不相同,基础的功能基本通用

html标签及其属性都能使用,md只是简化前端代码且文本更直观。

<p style="text-indent: 2em;margin: 0;padding: 0;color: red;font-size: 19px">p标签,内容设置样式,idea能正常显示样式,csdn没有样式,只是去掉了p标签</p>

p标签,内容设置样式,idea能正常显示样式,csdn没有样式,只是去掉了p标签

设置css样式,在idea中,文件>设置>语言和框架>markdown>自定义css,勾选加载自选择引入css样式表,或者勾选css规则在下面编写。图片为img标签,链接为a标签,标题为h1~6标签,等等,也可引入插件样式表,直接用类名。高亮对应mark或m标签。

idea可以直接复制图片后粘贴到md文件内指定位置,自动在md文件同路径下生成png图片,并生成代码。
idea的markdown设置位置

10.流程图

流程图和数学公式一样,需要引入插件或者修改配置

csnd使用的是Mermaid,参考文档

有的是使用flow,参考文档

在idea中,```mermaid```即可出现下载图标,可下载mermaid。也可在设置中语言和框架下markdown里,Mermaid或者PlanUML安装后勾选上。即可使用

csdn显然简化了英文,使用箭头等符号代替,语法相近,单词/符号不完全互通。

流程图代码首行flowchart+缩写或者graph+缩写,下面使用id【显示内容】,默认方形,默认显示id,(((官网显示三层圆括号可以显示圆环,idea和csdn这里失效)))

idea 使用mermaid无法显示中文,暂未解决。

  • TB - top to bottom
  • TD - top-down/ same as top to bottom
  • BT - bottom to top
  • RL - right to left
  • LR - left to right
%% 这是注释的方式
flowchart LRid1[id1] --> id2(id2)-->id3[(id3)]-->id4([id4])-->id5[[id5]]-->id6((id6))-->id7>id7]-->id8{id8}-->id9{{id9}}-->id10[/id10/]-->id11[\id11\]-->id12[/id12\]-->id13[\id13/]
id1
id2
id3
id4
id5
id6
id7
id8
id9
id10
id11
id12
id13
flowchart LR1-->2---3--text---4---|text|5-->|text|6--text-->7-.->8==>9 & 10-->11-->12 & 13-->14 & 15--o16A <--> B --o C o--o D x--xE
text
text
text
text
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
A
B
C
D
E

subgraph 设置子流程名称,直到end为止,不同流程间可以交叉,以代码顺序先后出现节点。子流程整体也可作为一个节点,子流程中可以嵌套其他子流程

flowchart TBa1--->b2c1--->b2subgraph Aa1 --- a2endsubgraph Bb1 ---> b2endc2-->b2
B
A
b2
b1
a2
a1
c1
c2

节点可绑定点击事件,可给链接

flowchart LR
A---B---C
%% callback为回调方法名,暂不知怎么声明
click A callback "等同注释?"
click B "http://ww.baidu.com" "msg"
click A call callback()
click B href "http://ww.baidu.com" "msg"
click C href "http://ww.baidu.com" "msg" _blank
A
B
C

style id 属性:值 即可设置对应节点样式

id(内容):::类名 对节点添加类名

class id名 类名 对节点添加类名

classDef 类名 属性:值,key2:value2 设置类名的样式

flowchart LRid1(Start):::class1-->id2(Stop)style id1 fill:#f9f,stroke:#333,stroke-width:4pxstyle id2 fill:#bbf,stroke:#111,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
%% style id key:value,key2,value2
%% fill:背景色,storke:边框颜色,stroke-width:边框宽度,color:字体颜色,stroke-dasharray:框线虚线小段长度 线段距离classDef class1 fill:pink
Start
Stop

内容中,不限引号,fa:className 内容,则会同时添加fa类和className类

flowchart TDB["fa:fa-twitter for peace"]B-->C[fa:fa-ban forbidden]B-->D(fa:fa-spinner);B-->E(A fa:fa-camera-retro perhaps?)
for peace
forbidden
A perhaps?

除了流程图,还有时序图,甘特图,饼状图等,也是mermaid支持的内容,太杂,日后再研究。以下为官网目录,本文仅依据文档整理了第一个Flowchart

在这里插入图片描述


http://chatgpt.dhexx.cn/article/qOViukTK.shtml

相关文章

.md文件的常用语法

正文&#xff1a; 1、标题的几种写法&#xff1a; 第一种&#xff1a; 前面带#号&#xff0c;后面带文字&#xff0c;分别表示h1-h6,上图可以看出&#xff0c;只到h6&#xff0c;而且h1下面会有一条横线&#xff0c;注意&#xff0c;#号后面有空格 第二种&#xff1a; 这种方…

README.md 文件的作用和语法

一、README.md 文件的作用 md文件一般出现在项目的根目录下面&#xff0c;其作用是&#xff1a;对项目的主要信息进行描述。 如果一个项目你很长时间都没有动&#xff0c;突然你需要修改这个项目&#xff0c;那么通过README.md中对项目的描述能让你快速的再次上手&#xff1b;或…

md文档编写语法

md文档编写语法 一、标题 语法&#xff1a;#后面跟空格&#xff0c;再加文字&#xff0c;几级就加几个# 例如&#xff1a; 这是一级标题&#xff08;# 这是一级标题&#xff09; 这是二级标题&#xff08;## 这是二级标题&#xff09; 这是三级标题 这是四级标题 二、字体…

常用md语法

基本要素 # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题一级标题 二级标题 三级标题 四级标题 五级标题 六级标题 分隔线 三个或更多的-表示分隔线 ---*斜体*斜体 **粗体**粗体 ***粗斜体***粗斜体 删除横线 ~~删除横线~~删除…

md基础语法总结

md即为Markdown,Markdown的目标是实现「易读易写」,可读性,无论如何,都是最重要的。其实md的底层最终还是将我们写的语法转化为html标签了 --------------------------------下面开始------------------------------------ 1.标题 # H1## H2### H3#### H4##### H5###### H6…

Markdown(MD)文档语法使用指南(学会后写文档写博客贼6)

文章目录 标题代码块多行代码块单行代码块 列表有序列表无序列表 图片链接分割线引用表格斜体、加粗、下划线、删除线 Markdown 是一种用来写作的轻量级「标记语言」&#xff0c;它用简洁的语法代替排版&#xff0c;而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版、…

.md文件格式语法详解,即markdown文件语法详解(图文并茂)

相关链接&#xff1a; 官网地址博客地址。截图博客地址。markdown版本&#xff0c;点击编辑源码地址。需IDEA克隆代码&#xff0c;用IDEA打开 Markdown 是一种轻量级的标记语言&#xff0c;本质是html。不同应用对md的支持度不一致(方言)&#xff0c;需要注意。 0.目录&…

md基本语法介绍

发现很多人都喜欢用.md&#xff08;markdown&#xff09;进行项目说明&#xff0c;眼馋其方便快捷的实用性&#xff0c;也学习一下&#xff0c;做个简单的笔记 1、标题修饰符 ‘#’ 标题分为h1~h6以#为标识符&#xff0c;#号的多少划分等级,而且仅有h1,h2是有下划线的&#xf…

Markdown最详细的语法教程,.md文件解读

.md即markdown文件的基本常用编写语法,是一种快速标记、快速排版语言&#xff0c;现在很多前段项目中的说明文件readme等都是用.md文件编写的&#xff0c;而且很多企业也在在鼓励使用这种编辑方式&#xff0c;特别作为一个前端从业者更要学会使用这种语言。 当然这种语言更适合…

.md 基本常用编写语法

.md文件基本常用编写语法 1.标题 第一种&#xff1a; # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题一级标题 二级标题 三级标题 四级标题 五级标题 六级标题 ​ 前面带#号&#xff0c;后面带文字&#xff0c;分别表示h1-h6,上图…

MD语法 官方参考

这里写自定义目录标题 欢迎使用Markdown编辑器新的改变功能快捷键合理的创建标题&#xff0c;有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants 创建一个自定义列表如何创建一个…

【md】1.markdown基础语法

一、基本文本使用 不是程序员的话&#xff0c;推荐只看本部分。后续的操作虽然也会用到部分&#xff0c;但频率很低&#xff0c;用的时候直接从目录跳转即可。 1、换行 直接回车。 2、段落 &#xff08;1&#xff09;、格式 换行两次 &#xff08;2&#xff09;、区别富…

.MD语法

.md即markdown文件的基本常用编写语法,是一种快速标记、快速排版语言&#xff0c;现在很多前段项目中的说明文件readme等都是用.md文件编写的&#xff0c;而且很多企业也在在鼓励使用这种编辑方式&#xff0c;特别作为一个前端从业者更要学会使用这种语言。下面就简单和大家分享…

md文档语法大全

目录 基本符号 标题 # 文字 # 文字 # 列表 无序列表 有序列表 嵌套列表 引用块 行引用 嵌套引用 代码块 链接 图片 分割线 表格 复选框 换行 其他 基础不牢&#xff0c;地动山摇&#xff0c;好的文档是项目质量及后续可维护的一个重要因素&#xff0c;每次…

PHPRunner 10.7.0 PHP代码生成器

PHPRunner 10.7.0 PHP代码生成器。 使用 PHPRunner 构建现代、功能丰富、响应迅速、数据驱动的 Web 应用程序。连接到 MySQL、SQL Server、MS Access 和 Oracle。这种快速的应用程序开发/低代码软件将使您的交付速度提高多达 90% - 它对于初学者来说很容易使用&#xff0c;但对…

generate-code开源的代码生成器(FlierTeam)

generate-code开源的代码生成器 一、背景二、项目链接三、功能介绍&#xff08;一&#xff09;通用代码生成器代码生成切换数据源下载 &#xff08;二&#xff09;可修改模板的生成器模板管理 四、总结 一、背景 从开源项目&#xff1a;https://gitee.com/QinHaiSenLin/Jfinal…

5.6 Mybatis代码生成器Mybatis Generator (MBG)实战详解

文章目录 前言一、Mybatis Generator简介二、Maven插件运行方式三、生成配置 generatorConfig.xmlMyBatis3Simple风格MyBatis3风格MyBatis3DynamicSql风格 四、Java代码运行方式五、MGB生成全部表六、增加Ext包七、Git提交总结 前言 本文我们主要实战Mybatis官方的代码生成器&…

软著代码生成器

软著代码生成器 介绍使用说明 使用下载 介绍 软著代码生成器 自动生成word 自动删除注释单行注释(python c# 等)每页50行代码自动删除空行 使用说明 下载解压即可使用 使用 下载 gitee下载地址 觉得好用的客官, 欢迎star

mybatis代码生成器

mybatis代码生成器 步骤一&#xff1a;在pom中安装mybatis generator 自动生成代码插件 步骤二&#xff1a;复制代码生成器代码&#xff0c;修改数据库配置&#xff0c;及实体类生成的位置即可 步骤三&#xff1a;增加配置启动命令 步骤一&#xff1a;在pom中安装mybatis gener…

C# 源代码生成器

C# 源代码生成器 什么是源生成器源生成器允许执行两个主要操作Microsoft 文档模型图示常见方案源生成器的使用1、创建 .NET控制台应用程序2、创建源生成器项目3、在控制台程序中使用生成器项目 结语 什么是源生成器 源生成器是由.NET Compiler Platform&#xff08;“Roslyn”&…