栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

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

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

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

文章目录
    • 标题
    • 代码块
      • 多行代码块
      • 单行代码块
    • 列表
      • 有序列表
      • 无序列表
    • 图片
    • 链接
    • 分割线
    • 引用
    • 表格
    • 斜体、加粗、下划线、删除线

Markdown 是一种用来写作的轻量级「标记语言」,它用简洁的语法代替排版,而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版、字体设置。它使我们专心于码字,用「标记」语法,来代替常见的排版格式。
Markdown 文档从内容到格式,甚至插图,通过键盘就可以通通搞定。现在大多数网站的编辑器都支持Markdown语法。(比如CSDN、语雀、掘金、钉钉文档、石墨文档等都支持Markdown语法)

标题

MD标题的语法为#号+空格,后面带标题文字,一个#到六个#加空格,分别代表一级标题到六级标题。
案例:

# 共饮一杯无H1
### 共饮一杯无H3
###### 共饮一杯无H6

效果:

代码块 多行代码块

MD多行代码块的语法为三个点开头和结尾,开头的点点点后面可以跟具体的代码块类型,比如java、js、html、shell等。
案例:

```java
    public static void main(String[] args) {
        System.out.println("HELLO WORLD,共饮一杯无");
    }
效果:
```java
public static void main(String[] args) {
    System.out.println("HELLO WORLD,共饮一杯无");
}
单行代码块

MD单行代码块的语法为`开头和结尾。
案例:

`showMeCode`

效果:
showMeCode

列表 有序列表

MD有序列表的语法为数字+空格+具体内容。
案例:

1. 学习md第一步,百度查找 Markdown(MD)文档语法使用指南。
2. 学习md第二步,进入共饮一杯无的 Markdown(MD)文档语法使用指南 文章学习。
3. 学会了,妈妈再也不用担心我不会md语法了。

效果:

  1. 学习md第一步,百度查找 Markdown(MD)文档语法使用指南。
  2. 学习md第二步,进入共饮一杯无的 Markdown(MD)文档语法使用指南 文章学习。
  3. 学会了,妈妈再也不用担心我不会md语法了。
无序列表

MD无序列表的语法有三种,分别为-+空格+具体内容、*+空格+具体内容和++空格+具体内容。
案例:

- 有序是暂时的,无序才是永恒的。
* 我们趋向于把无序的东西变为有序,而不是让有序的东西变为无序。
+ 宇宙最开始是一种混沌状态。

效果:

  • 有序是暂时的,无序才是永恒的。
  • 我们趋向于把无序的东西变为有序,而不是让有序的东西变为无序。
  • 宇宙最开始是一种混沌状态。
图片

MD图片的语法为!+[图片内容说明]+(图片具体地址的链接地址或者路径)
案例:

![编写高质量代码方法](https://userblink.csdnimg.cn/20220518/qq_35427589/pic/85c540a72edc5dedffffc42928a054a2-0.png?x-oss-process=image/watermark,image_bG9nby9sb2dvM3gucG5nP3gtb3NzLXByb2Nlc3M9aW1hZ2UvcmVzaXplLGhfMjg=,text_QOWFsemlruS4gOadr-aXoA==,color_FFFFFF,size_30,type_ZmFuZ3poZW5naGVpdGk,shadow_20,t_50,g_se,x_16,y_16,order_0,align_2,interval_4)

效果:

链接

MD链接的语法为[链接内容说明]+(具体地址的链接地址)。
案例:

[共饮一杯无的博客汇总‍](https://blog.csdn.net/qq_35427589?type=blog)

效果:
共饮一杯无的博客汇总‍

分割线

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

以下是分割线:
---
*****
____

效果:
以下是分割线:




引用

MD引用的语法为>+空格+具体内容。
案例:

> 本文引用了共饮一杯无的Markdown(MD)文档语法使用指南。

效果:

本文引用了共饮一杯无的Markdown(MD)文档语法使用指南。

表格

MD表格的语法为哈哈不大好描述,直接看案例吧。
案例:

| Column 1 | Column 2  |	Column 3 |
|:--------| :---------:|--------:|
| centered 文本居左 | right-aligned 文本居中 |right-aligned 文本居右|

车辆信息:

| 车型 | 颜色  |	报价 |
|:--------|:---------:|-----:|
| 法拉利 | 红色 | 500达不溜 |
| 劳斯莱斯 | 金色 | 666达不溜 |
| 布加迪 | 黑色 | 3246达不溜 |

效果:

Column 1Column 2Column 3
centered 文本居左right-aligned 文本居中right-aligned 文本居右

车辆信息:

车型颜色报价
法拉利红色500达不溜
劳斯莱斯金色666达不溜酪
布加迪️黑色3246达不溜
斜体、加粗、下划线、删除线

MD斜体的语法为_+具体内容。
案例:

_比萨斜体

效果:
比萨斜体

MD粗体的语法为**+具体内容+**。
案例:

**我是大粗体**

效果:
我是大粗体

MD下划线的语法为+具体内容+。
案例:

我是下划线‍♀️

效果:
我是下划线‍♀️(csdn的编辑器好像不支持),实际效果如下:

MD删除线的语法为~~+具体内容+~~。
案例:

~~我是被删除的~~

效果:
我是被删除的

文末彩蛋:MD文档,搭配emoji表情使用更佳。常用emoji表情可以查看我这篇文章:emoji语言常用图标收集(有趣的emoji)

参考:https://daringfireball.net/projects/markdown/

本文内容到此结束了,
如有收获欢迎点赞收藏关注✔️,您的鼓励是我最大的动力。
如有错误❌疑问欢迎各位大佬指出。
主页:共饮一杯无的博客汇总‍

保持热爱,奔赴下一场山海。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/952539.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号