如何编辑 .md 文档 (基础)

SW
• 阅读 589

如何编辑 .md 文档

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。

Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

Markdown 编写的文档后缀为 .md, .markdown。

  工具:VSCode

一、标题

标题其实和HTML中的h系列很像,想要设置为标题的文字前面加#来表示 一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

注:标准语法一般在#后跟个空格再写文字 示例:

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

效果如下:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

二、字体

加粗:要加粗的文字左右分别用两个 * 号包起来

斜体:要倾斜的文字左右分别用一个 * 号或者用 _ 包起来

斜体加粗:要倾斜和加粗的文字左右分别用三个*号包起来

删除线:要加删除线的文字左右分别用两个~~号包起来

示例:

**加粗**
*斜体*  _斜体_
***斜体加粗***
~~删除线~~

效果如下:

加粗 斜体 斜体 斜体加粗 删除线

三、引用

在引用的文字前加>即可。引用也可以嵌套,如加两个>>三个>>> n个...

示例: >这是引用的内容 >>这是引用的内容 >>>这是引用的内容 >>>>...

效果如下:

这是引用的内容

这是引用的内容

这是引用的内容

...

四、分割线

三个或者三个以上的 - 或者 * 都可以。

示例: --- ***

效果如下:



五、图片

语法:

![图片alt](图片地址 "图片title")

图片alt就是显示在图片下面的文字,相当于对图片内容的解释。 图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加

效果如下:

如何编辑 .md 文档 (基础)

六、超链接

语法:

[超链接名](超链接地址 "超链接title")
title可加可不加

示例: 百度

七、列表

无序列表

语法: 无序列表用 - + * 任何一种都可以

- 列表内容
+ 列表内容
* 列表内容

注意:- + * 跟内容之间都要有一个空格 效果如下:

  • 列表内容
  • 列表内容
  • 列表内容

有序列表

语法: 数字加点加空格

1. 列表内容
2. 列表内容
3. 列表内容

注意:序号跟内容之间要有空格

效果如下:

  1. 列表内容
  2. 列表内容
  3. 列表内容

列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格即可:

- 无序列表
    1. 有序列表
    2. 有序列表
- 无序列表
    1. 有序列表
    2. 有序列表
        - 无序列表

效果如下:

  • 无序列表
    1. 有序列表
    2. 有序列表
  • 无序列表
    1. 有序列表
    2. 有序列表
      • 无序列表

八、表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

语法格式如下:

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右

效果如下: | 表头 | 表头 | | ---- | ---- | | 单元格 | 单元格 | | 单元格 | 单元格 |

对齐方式:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

我们可以设置表格的对齐方式:

-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。

效果如下: | 左对齐呵呵哈哈哈 | 右对齐哈哈哈 | 居中对齐呵呵哈哈哈 | | :-----| ------: | :----: | | 单元格 | 单元格 | 单元格 | | 单元格 | 单元格 | 单元格 |

九、代码

语法: 单行代码:代码两边用一个反引号括起来

`prinf()`

多行代码:用三个反引号括起来,在第一个```后可以标注语言类型

    ```sql
    -- 创建表
    CREATE TABLE emp (
    -- int类型
    emp_id INT,
    -- 最多保存20个中英文字符
    emp_name VARCHAR(20),
    -- 总位数不超过15位
    salary DOUBLE,
    -- 日期类型
    birthday DATE
    );
    ```

效果如下: prinf()

-- 创建表
CREATE TABLE emp (
-- int类型
emp_id INT,
-- 最多保存20个中英文字符
emp_name VARCHAR(20),
-- 总位数不超过15位
salary DOUBLE,
-- 日期类型
birthday DATE
);

其他

目录[TOC]

在想要显示目录的位置标注: [TOC]

首行缩进:  

 表示一个中文字符间隔

参考:菜鸟教程

点赞
收藏
评论区
推荐文章
待兔 待兔
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
不才 不才
3年前
md-loader
mdloader组件文档是如何渲染出来文档用于描述系统功能,而组件文档描述组件的功能,对于前端组件为了直观体现一般会有一个预览模块,而一般组件文档都是采用markdown编写,而md是文本内容且并没有渲染组件代码的能力,那么这是如何做的呢?简单的说就是“自定义结构”,像elementui中对代码的描述为,中间的YOUCODE可以放简单的vue组件代码。这种
Symbol卢 Symbol卢
3年前
markdwon常用语法
什么是markdwon?Markdown是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。Markdown语言在2004由约翰·格鲁伯(英语:JohnGruber)创建。Markdown编写的文档可以导出HTML、Word、图像、PDF、Epub等多种格式的文档。Markdown编写的文档后缀为.md,.markdow
Stella981 Stella981
3年前
AndroidStudio封装SDK的那些事
<divclass"markdown\_views"<!flowchart箭头图标勿删<svgxmlns"http://www.w3.org/2000/svg"style"display:none;"<pathstrokelinecap"round"d"M5,00,2.55,5z"id"raphael
Wesley13 Wesley13
3年前
VS Code实现markdown画流程图
安装最新的vscode编辑器,原生支持markdown语法。不会markdow的人可以去好好学下,写文档神器!!!1、安装MarkdownPreviewEnhanced插件!(https://oscimg.oschina.net/oscnet/51c00974c0d771d52c9c93fcd2cf701b400.png)2、本地新建
Wesley13 Wesley13
3年前
Markdown简介
Markdown是什么  Markdown是一种完全由标点符号标记的纯文本,这些标点符号被Markdown赋予表达含义以使得文本看上去可以代表特定的语义,比如:井号标记代表标题、星号标记代表强调、两个星号标记代表加粗。  Markdown设计之初只是让写作文档和阅读文档变得更容易,因Markdo
Stella981 Stella981
3年前
Markdown
MarkdownMarkdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。现在所写的语法就是Markdown语法目录语法结构(语法结构)表格(表格)图片插入(图片插入)工具(工具)
凿壁偷光 凿壁偷光
1年前
Markdown格式预览PreviewMarkdown for mac
PreviewMarkdown为使用流行的Markdown标记格式创建的文档提供QuickLook文件预览和文件图标缩略图。
绣鸾 绣鸾
1年前
Ulysses 30 for Mac(Markdown文本编辑器)
是一款适用于Mac和iOS设备的优秀文本编辑器,可帮助用户创建和编辑各种文档和写作项目。它具备简单、干净的界面和强大的功能,如Markdown支持、分组管理、标签、搜索等。Ulysses还提供了多种灵活的导出选项,可以将文档导出为多种格式,如ePub、PD
liam liam
1年前
超简单!Java 项目自动生成接口文档教程
你还在用word、markdown埋头苦干写?写文档这件事恐怕是每个开发都万分抗拒的事情了。本篇文章详细教你如何利用插件工具,在IDEA中自动生成API文档。先来看看从IDEA中生成文档的效果如下图。下图是使用Apifox插件(Apifoxhelper)从
SW
SW
Lv1
世间无限丹青手,一片伤心画不成。
文章
1
粉丝
0
获赞
0
热门文章

暂无数据