Markdown格式介绍 Markdown格式详解

2025-12-08 21:43:00
admin
原创 229
摘要:Markdown格式介绍 Markdown格式详解

一、Markdown格式介绍

1、一种标记语言,注重文本内容,精简格式标签,更加容易读写;

2、有些应用软件支持在markdown文本中使用html标签;

3、块级的html标签不要和markdown标签一起使用;


网络资源:

1、语法帮助:https://www.markdownguide.org/basic-syntax

2、语法帮助:https://markdownguide.offshoot.io/extended-syntax

3、语法帮助:https://www.markdownlang.com/zh/basic/overview.html

4、commonmark语法帮助:https://spec.commonmark.org

5、gfm语法帮助:https://docs.github.com/en/get-started

6、在线编辑:https://www.jotbird.com/app

7、离线编辑:https://kde.github.io/ghostwriter/download.html


markitdown使用帮助:

1、to_markdown:https://github.com/microsoft/markitdown

2、ffmpeg:https://ffmpeg.org/download.html

3、ffmpeg:https://github.com/BtbN/FFmpeg-Builds/releases

4、运行过程中如果发出告警缺少ffmpeg,则需要安装ffmpeg;

5、pip install 'markitdown[all]'

6、markitdown mydoc.docx -o mydoc.md


marked使用帮助:

1、to_html:https://marked.js.org

2、to_html:https://github.com/markedjs/marked

3、npm install -g marked

4、marked -i mydoc.md -o mydoc.html


二、Markdown格式详解

标题、段落、换行:

1、标题:开头必须使用#,结尾可选使用# ,开头的#数量决定标题级别;

2、标题:一个#开头表示标题1,两个#开头表示标题2,开头结尾的#与内容之间必须有空白字符

3、标题:文本行下面加任意数量==表示标题1,文本行下面加任意数量--表示标题2,不推荐使用;

4、段落:文本行之间使用一个空白行,表示不同段落;

5、换行:文本行结尾使用<br>,然后换行,表示进行换行;

6、换行:文本行结尾使用两个及以上空白字符,然后换行,表示进行换行;

7、加粗和斜体:**text**表示加粗,*text*表示斜体,***text***表示加粗+斜体,不推荐使用_替换*;


列表、块引用、代码块、单行代码

1、有序列表:开头必须使用num+dot,数字不需要有序,但必须从一开始,多级列表使用缩进;

2、无序列表:开头必须使用-或*或+,不建议混合使用,多级列表使用缩进;

3、块引用:块引用的基本单位是段落,引用单个段落使用>,引用多个段落空白行也要使用>;

4、块引用:嵌套引用使用>>,支持使用其他格式标签,比如标题标签,比如列表标签;

5、代码块(有缩进方式):代码使用4个空格或1个缩进,列表里面使用8个空格或2个缩进;

6、代码块(无缩进方式):代码前一行使用```,代码后一行使用```,`可以替换为~;

7、单行代码:`code text`表示单行代码,``code text``表示单行代码;


水平线、链接、图片:

1、水平线:三个及以上*或-或_表示水平线,***或---或__表示水平线

2、链接:[text](url)链接到url,<url>链接到url,<email>链接到邮箱,url的空格需要编码;

3、图片:![missing picture](some_image.png),图片不存在时展示文字,图片也支持链接;

发表评论
评论通过审核之后才会显示。