.MD语法入门,教你写好readme文档

article/2025/10/12 8:46:05

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

题外话:我一般不安装markdown编辑器,直接用idea就可以编写。

一、基本符号:* - +. >

基本上所有的markdown标记都是基于这四个符号或组合,需要注意的是,如果以基本符号开头的标记,注意基本符号后有一个用于分割标记符和内容的空格。

二、标题

1.前面带#号,后面带文字,分别表示h1-h6,只到h6,而且h1下面会有一条横线

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

2.相当于标签闭合

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

三、列表

  1. 无序列表
//形式一
+ a
+ b
+ c
//形式二
- d
- e
- f
//形式三
* g
* h
* i
  1. 有序列表
//正常形式
1. abc
2. bcd
3. cde
//错序效果
2. fgh
3. ghi
5. hij

如图,注意,数字后面的点只能是英文的点,有序列表的序号是根据第一行列表的数字顺序来的,
错序列表的序号本来是序号是乱的, 但是还是显示 2 3 5

  1. 嵌套列表
//无序列表嵌套
+ 123+ abc+ bcd+ cde
+ 465
+ 789
//有序列表嵌套
1. abcd1. abcde2. abcde3. abcde
2. bcde
3. cdef

列表可以嵌套,使用时在嵌套列表前按 tab 或 空格 来缩进,去控制列表的层数

四、引用说明区块

对某个部分做的内容做一些说明或者引用某某的话等,可以用这个语法。

  1. 正常形式
> 引用内容、说明内容。在语句前面加一个 > ,注意是英文的那个右尖括号,注意空格,引用因为是一个区块,理论上是应该什么内容都可以放,比如说:标题,列表,引用等等。
  1. 嵌套区块
    这里我只介绍一下我常用的方法,也是个人认为比较规范的一种方法,就是给区块的下一级区块多加一个右尖括号
> 一级引用
>> 二级引用
>>> 三级引用
>>>> 四级引用
>>>>> 五级引用
>>>>>> 六级引用

五、代码块

在发布一些技术文章会涉及展示代码的问题,这时候代码块就显得尤为重要。

  1. 少量代码,单行使用,直接用`包裹起来就行了
` shaoliangdaima,danhangshiyong `
  1. 大量代码,需要多行使用,用```包裹起来
    ```daliangdaima,xuyaoduohangshiyongdaliangdaima,xuyaoduohangshiyongdaliangdaima,xuyaoduohangshiyongdaliangdaima,xuyaoduohangshiyongdaliangdaima,xuyaoduohangshiyong```

六、链接

  1. 行内式
    链接的文字放在[]中,链接地址放在随后的()中,链接也可以带title属性,链接地址后面空一格,然后用引号引起来
[简书](https://www.jianshu.com "创作你的创作"),
是一个创作社区,任何人均可以在其上进行创作。用户在简书上面可以方便的创作自己的作品,互相交流。 
  1. 参数式
    链接的文字放在[]中,链接地址放在随后的:后,链接地址后面空一格,然后用引号引起来
[简书]: https://www.jianshu.com "创作你的创作"
[简书]是一个创作社区,任何人均可以在其上进行创作。用户在简书上面可以方便的创作自己的作品,互相交流。
//参数定义的其他写法
[简书]: https://www.jianshu.com '创作你的创作'
[简书]: https://www.jianshu.com (创作你的创作)
[简书]: <https://www.jianshu.com> "创作你的创作"

七、图片

  1. 行内式
    和链接的形式差不多,图片的名字放在[]中,图片地址放在随后的()中,title属性(图片地址后面空一格,然后用引号引起来),注意的是[]前要加上!
![my-logo.png](https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 "my-logo")
  1. 参数式
    图片的文字放在[]中,图片地址放在随后的:后,title属性(图片地址后面空一格,然后用引号引起来),注意引用图片的时候在[]前要加上!
[my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 "my-logo"
![my-logo.png]
//参数定义的其他写法
[my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 'my-logo'
[my-logo.png]: https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 (my-logo)
[my-logo.png]: <https://upload-images.jianshu.io/upload_images/13623636-6d878e3d3ef63825.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240> "my-logo"

八、分割线

分割线可以由* - _(星号,减号,底线)这3个符号的至少3个符号表示,注意至少要3个,且不需要连续,有空格也可以

---
- - -
------
***
* * *
******
___
_ _ _
______

九、其他

  1. 强调字体
    一个星号或者是一个下划线包起来,会转换为<em>倾斜,如果是2个,会转换为<strong>加粗
*md*    
**md**
_md_   __md__
  1. 转义
    基本上和js转义一样,\加需要转义的字符
\\
\*
\+
\-
\`
\_
  1. 删除线
    用~~把需要显示删除线的字符包裹起来
~~删除~~

十、表格

//例子一
|123|234|345|
|:-|:-:|-:|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
//例子二
|123|234|345|
|:---|:---:|---:|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
//例子三
123|234|345
:-|:-:|-:
abc|bcd|cde
abc|bcd|cde
abc|bcd|cde

上面三个例子的效果一样,由此可得:
1. 表格的格式不一定要对的非常起,但是为了良好的变成风格,尽量对齐是最好的
2. 分割线后面的冒号表示对齐方式,写在左边表示左对齐,右边为右对齐,两边都写表示居中

 


http://chatgpt.dhexx.cn/article/6NtZgWKX.shtml

相关文章

编辑MD文件的语法格式

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

.md,markdown文件的基本常用编写语法

序言&#xff1a; 很久没有写博客了&#xff0c;感觉只要是不写博客&#xff0c;人就很变得很懒&#xff0c;学的知识点感觉还是记不住&#xff0c;渐渐地让我明白&#xff0c;看的越多&#xff0c;懂的越少&#xff08;你这话不是有毛病吗&#xff1f;应该是看的越多&#xff…

.md即markdown文件常用语法

参阅cmd版官网&#xff1a;markdown 参考博文&#xff1a;Markdown语法介绍&#xff08;详细&#xff09; 1.标题 使用#符号包起来&#xff0c;符号和内容中间空格可省略&#xff0c;尾部#号可省略。依次1~6级标题&#xff0c;对应html中的h1~6标签 会使上一行成为一级标题&…

.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官方的代码生成器&…