元某人也元某人也

Markdown 语法详解

Markdown 语法详解与写作排版参考。

本文目录

Markdown语法详解

一小时快速上手,程序员必备的Markdown语法,轻松编写规范文档。

什么是Markdown?

Markdown 致力于使阅读和创作文档变得容易。

Markdown 是一种轻量级的标记语言,设计初衷是让人们可以使用简单的文本格式来书写和编辑文档,同时具有一定的格式化效果,通过使用Markdown语法,用户可以快速地将纯文本转化为格式化的文档,例如标题、列表,链接,图片等。 Markdown 语法简单直观,易于学习和使用,逐渐成为了各种平台上书写文档的常用格式。甚至还可以实现 Markdown 文档对 PDF、Word 等格式的快速转换。

Markdown 的文件通常以.md 或.markdown 为扩展名。

基础语法详解

换行

这是第一段文本, 这是第二段文本

上面两端文本如果需要换行,表现出类似于这样的效果

这是第一段文本,
这是第二段文本。

需要在换行的同时在前面先敲两个空格,否则不会表现出换行的样式。即空格空格回车为手动换行符。

或者直接敲两个回车,达成更换段落的效果。

加粗/斜体

这是一段普通的文本信息

如果我们要加粗一段文字,可以在文字左右分别加上两个**

这是一段普通的文本信息

即可达成效果。(下划线也可达成同样的效果)

也可以直接在句子中的单个词语或文字旁边加上星号。

这是一段普通的文本信息。

如果只加一个星号,则表现出斜体的效果。

三个则是斜体和加粗的效果。

删除线

在语段前后分别加两个~,可以让~中间的字体加上删除先

这是一段文本

当然也可以和*混合使用

这是一段文本

这是一段文本

星号和波浪线的位置不重要,只要互相对应就好了

分割线

这是一段文本1


这是一段文本2

在两行文本之间加上三个(以上)***(___)即可(后面不可以写内容,星号不包括空格),或者三个中间有空格的减号

标题

如果我们现在想要创建一个一级标题,在要写的文本前面写一个井号和空格即可

示例

二级标题则是两个井号

示例

三级标题则是三个

示例

以此类推(到六级标题)。

或者在语段下一行打出等号表示一级标题,在语段下一行打出减号表示二级标题(不常用)

有序/无序列表和勾选框

无序列表

  • 我是第一项任务
  • 我是第二项任务
  • 我是第三项任务

使用*(+、-)和一个空格符号表示列表。(不可以混用,会被分为不同的列表)

有序列表

  1. 我是第一项任务
  2. 我是第二项任务
  3. 我是第三项任务

直接1. 2. 3. 加空格表示,必须从1234按顺序往下走,但第一项可以自定义,即4. 2. 3. 的顺序表示

列表嵌套

在二级列表前面加上四个空格(符号不能缺失),逐级四位递增

  1. 我是第一项任务
    • 我是二级列表
      1. 我是三级列表
  2. 我是第二项任务
  3. 我是第三项任务

列表换行

虽然加两个空格回车可以换行,但是对其的不是列表序号,所以我们需要另一种方法。

勾选框

在列表的基础上再符号后面加上 - [ ](英文),方框内写上x可以表示已勾选

    • 我是第一项任务
    • 我是第二项任务
    • 我是第三项任务
  • 123
    • 子待办事项(支持嵌套,需额外缩进2个空格)

代码块

public class Main {
    public static void main(String[] args){
        System.out.println("Hello World");
    }
}

方法一

在代码前连着打三个 ```,

后面也连着打三个 ```,可以在第一组符号后面写上语言类型

1
2
3
4
5
public class Main {
    public static void main(String[] args){
        System.out.println("Hello World");
    }
}    

在行内要让函数名被标注,直接在其左右两边加上一个 ` 即可。

如:调用equals()方法。

方法二

在代码的每一行前面加上四个空格。

public class Main {
    public static void main(String[] args){
        System.out.println("Hello World");
    }
}

引用文本

在语段前面加上一个> 表示这是我从别人的文章摘抄过来的。
如果要换行的话遵循正常文本的换行规则,但是不能直接空一行,否则会认为是另一段文本

或者在每一段前面加上尖括号,源代码比较清晰。

当然也可以嵌套其他的内容,代码块,列表,引用等。

超链接

初级用法

直接将网站贴上去之后显然不够美观

https://www.bilibili.com/

所以我们可以将超链接,直接将超链接的载体左右两边加上方框,在右方框后面加上小括号,小括号贴上链接

如:前往bilibili官网观看视频。

高级用法

当一段话有数量较多的超链接时,我们可以在每个文本的右括号在加一组方括号,括号内给其起名,然后再文章末写上方框与起的名字,冒号,冒号后面空一格写上链接。

如:前往bilibili或者腾讯视频观看视频

而且变量是可以复用的。

角注(索引,注释)

想要购买请前往官网1

再要注释的地方后边加上方框,方框内写上^与变量名,变量名的赋值与超链接相同。

图片的插入

图片的插入只能以链接(网络或本地)的形式上传。一般推荐以网络形式上传。

首先打上一个感叹号,方括号,小括号

图片

方括号内写名字,小括号写链接。这个图片不能手动调整大小。部分软件可以再链接后面写上"",中间加上文字表示鼠标悬浮时的备注。

图片2

本地上传可以直接写图片名字。也可以使用与超链接方式相同的变量方式命名。

表格的插入

编写表格

姓名年龄性别成绩
小明18男
小红17女

图片2

如图所示。

表格的形式

在分割线左面加上冒号为左对齐,右面加上冒号为右对齐,两边都加为居中。

嵌入式HTML语言(学习前端过后可看)

我暂时没学HTML,但似乎直接写HTML语言就行。

其他拓展语法

这些语法是Markdown的拓展语法,这里无法显示,只做举例(可以使用HTML替代,但是我没学)

下标 上表 高亮

在文本左右加两个等号为高亮。

==这是高亮文本==

上标,在上标位置加上^^中间加上标内容

x^2^

下标将^替换为飘号键~

x2

数学公式的插入与排版

美元符号的使用

使用两个美元符号,中间加上内容,不可换行。

$x = 1 + y$

或者在文本的上下两行分别打两个美元符号,中间全部内容变为数学公式的样式。

$$ \frac{1}{x}*5 $$

分数

在右斜杠后面加上frac{}{},两个花括号表示分子和分母。

由于我暂时为配置数学公式的兼容,所以这篇文章到此为止


  1. 我是角注 ↩︎

仅用于交流学习,记录学习心得