首页 > 其他分享 >Markdown语法详解及常见的使用场景

Markdown语法详解及常见的使用场景

时间:2024-10-25 22:47:01浏览次数:5  
标签:--- Markdown 斜体 列表 语法 详解 文档 文本

Markdown语法详解

Markdown概念

Markdown是一种轻量级标记语言,以其简洁、高效、易读、易写的特点而被广泛使用。Markdown语法通过纯文本格式编写文档,支持与HTML混编,并可导出HTML、PDF以及.md格式的文件。本文将对Markdown的基本语法及其高级用法进行详细介绍。

一、标题

Markdown使用#符号来创建不同级别的标题,#的数量代表标题的级别。

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

例如:

# 这是一级标题
## 这是二级标题
### 这是三级标题
二、段落

段落由一行或多行文本组成,每段之间需要有一个空行隔开。

例如:

这是一个段落。

这是另一个段落。
三、字体样式

Markdown支持斜体、粗体和斜体加粗。

  • 斜体:使用*_包裹文本,如*斜体文本*_斜体文本_
  • 粗体:使用**__包裹文本,如**粗体文本**__粗体文本__
  • 斜体加粗:使用***___包裹文本,如***斜体加粗文本***___斜体加粗文本___

例如:

*斜体文本*
**粗体文本**
***斜体加粗文本***
四、列表

Markdown支持有序列表和无序列表。

  • 无序列表:使用-*+作为列表标记,后面加一个空格。
  • 有序列表:使用数字并加上.表示,如1. 项目一

列表可以嵌套,子列表前添加四个空格或tab。

例如:

- 无序列表项一
  - 子项一
  - 子项二
- 无序列表项二

1. 有序列表项一
2. 有序列表项二
   1. 子项一
   2. 子项二
五、链接和图片
  • 链接:使用[链接文本](链接地址)语法。
  • 图片:使用![替代文字](图片地址)语法。

例如:

[这是一个链接](https://www.example.com)
![这是一张图片](https://www.example.com/image.jpg)
六、代码
  • 内联代码:使用反引号`包裹代码,如`内联代码`
  • 代码块:使用三个反引号```````````包裹代码,并可以指定语言。

例如:

`内联代码`

```python
def hello_world():
    print("Hello, world!")

#### 七、表格

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

例如:
```markdown
| 列1 | 列2 | 列3 |
| --- | --- | --- |
| 数据1 | 数据2 | 数据3 |
| 数据4 | 数据5 | 数据6 |

表格可以设置对齐方式:

  • :--- 左对齐
  • :---: 居中对齐
  • ---: 右对齐

例如:

| 左对齐 | 居中对齐 | 右对齐 |
| :--- | :---: | ---: |
| 文本 | 文本 | 文本 |
| 文本 | 文本 | 文本 |
八、分隔线

使用三个以上的*-_来创建一个分隔线,行内不能有其他东西。

例如:

***
---
_____
九、引用

Markdown使用>符号来引用文本,可以嵌套。

例如:

> 这是一个引用。
> > 这是一个嵌套引用。
十、删除线和下划线
  • 删除线:使用两个波浪线~~包裹文本,如~~被删除的文字~~
  • 下划线:可以使用HTML标签<u>实现,如<u>带下划线文本</u>

例如:

~~被删除的文字~~
<u>带下划线文本</u>
十一、脚注

Markdown脚注用于对文本进行补充说明,格式如下:

这是一个脚注[^1]。

[^1]: 这是脚注的内容。
十二、任务列表

任务列表使用- [ ]表示未完成的任务,- [x]表示已完成的任务。

例如:

- [ ] 未完成的任务
- [x] 已完成的任务
十三、高级技巧
  1. HTML元素:Markdown支持直接使用HTML标签,如<b><i><em>等。
  2. 转义字符:使用\来转义特殊字符,如\\*_等。
  3. 数学公式:许多Markdown编辑器支持使用LaTeX语法来插入数学公式,如$E = mc^2$$$E = mc^2$$
十四、目录生成

在Markdown文件开头添加 @[TOC] ,可以自动生成目录。


Markdown的应用场景

  1. 个人笔记与知识管理

    • 用户可以利用Markdown的简洁语法记录笔记、整理读书心得或构建个人知识体系。
    • 生成的文档既便于阅读也易于维护,而且可以方便地转换为不同格式进行备份或分享。
  2. 技术文档编写

    • 对于软件开发、IT项目管理等领域,Markdown是编写API文档、用户手册、技术指南的优选工具。
    • 通过文档生成软件,可以将Markdown源码转换为美观且结构清晰的HTML、PDF或电子书,方便团队成员查阅和更新。
  3. 博客与网站内容创作

    • 许多博客平台和静态站点生成器(如Jekyll、Hugo)支持Markdown作为内容输入格式。
    • 内容创作者可以专注于写作,而不用担心排版问题,Markdown内容可以方便地转化为网站兼容的格式。
  4. 学术论文与研究报告

    • 结合Markdown的扩展语法(如MathJax支持数学公式),科研人员和学生可以编写含有复杂公式的学术文档。
    • 通过文档生成软件,可以导出为符合学术出版标准的格式。
  5. 项目管理与协作

    • 在团队项目中,Markdown文档因其简单易懂的特性,常用于编写项目计划、会议纪要、任务分配等。
    • 配合版本控制系统(如Git),Markdown文档生成软件有助于保持文档与项目代码同步更新。
  6. 教程与课程材料

    • 教育工作者和在线课程开发者使用Markdown编写教学大纲、教程步骤和练习题。
    • 文档生成软件帮助他们快速制作结构化且格式统一的教学材料。
  7. 书籍创作与电子书发布

    • 对于独立作者和出版商,Markdown提供了一种低门槛的途径来编写书籍内容。
    • 通过专业软件,可以将其转换为ePub、MOBI等电子书格式,便于在各种电子阅读设备上分发。
  8. README文件编写

    • 在软件开发过程中,README文件是项目的重要组成部分,它向用户介绍项目的基本信息、安装步骤、使用方法等。
    • Markdown语法简洁明了,非常适合用于编写README文件,使其易于阅读和理解,同时保持代码库的整洁和一致性。
  9. 技术博客撰写

    • 技术博客文章通常包含丰富的代码示例、技术说明和步骤指南。
    • Markdown支持代码块和语法高亮,使得插入和展示代码变得简单,同时支持列表和标题,有助于组织和格式化文章内容。

标签:---,Markdown,斜体,列表,语法,详解,文档,文本
From: https://blog.csdn.net/qq_63447955/article/details/142769880

相关文章

  • EM算法详解
    EM算法详解EM(Expectation-Maximization)算法,即期望最大化算法,是一种在机器学习、数据挖掘等领域有着广泛应用的迭代优化策略。它不仅被评选为“数据挖掘十大算法”之一,还被吴军博士在《数学之美》一书中誉为“上帝视角”算法,足见其重要性。本文将深入介绍EM算法的基本原理、......
  • 【STC8H】使用ADC第15通道测量外部电压及电池电压详解
     STC8H系列ADC的第15通道用于测量内部参考信号源,由于内部参考信号源很稳定,约为1.19V,且不会随芯片的工作电压的改变而变化,所以可以通过测量内部1.19V参考信号源,然后通过ADC的值便可反推出外部电压或外部电池电压。以下是如何设置和读取ADC第15通道的详细步骤: 1......
  • 【C语言】扫雷详解(手把手教你敲扫雷)
    目录前言正文开始1.扫雷游戏的分析与设计1.1扫雷游戏的功能说明1.2游戏的分析和设计1.2.1数据结构的分析1.2.2文件结构设计2.代码实现2.1.1文件game.h2.1.2文件game.c2.1.3文件test.c2.2讲解2.2.1主体2.2.2有关定义2.2.3函数1.InitBoard()初始化棋盘2.SetMin......
  • md文件转html (使用vscode 中的markdown---->html)
    一、采用vscode 制作和打开md文件 1.1安装markdown和markdownoreviewenhanced扩展插件1.2 修改设置  1.3用vscode打开md文件,右键--->点击---下图按钮。生成.md,然后右键点击export--->html--->html(offline) .最后就生成html格式的文件啦。记得三......
  • JS高级-手写Promise详解
    Promise的标准化之路并非一帆风顺。在Promise被正式纳入ECMAScript规范之前,有很多不同的实现和行为模式。这些差异导致了兼容性问题和在不同环境下的不可预测行为,因此产生了对统一标准的需求,最终促成了PromiseA+规范的诞生在上一章节开头中,我们简单实现Promise之前的异步......
  • DA-CLIP-universal-image-restoration代码详解
    DA-CLIP-universal-image-restoration代码详解创建模型model=create_model(opt)device=model.devicecreat_model最终指向ConditionalUNet类,类的主要结构如下:classConditionalUNet(nn.Module):def__init__(self,in_nc,out_nc,nf,ch_mult=[1,......
  • 完整的 Markdown 教程:从基础到高级
    #Markdown Markdown 是一种轻量级标记语言,可以轻松设置文本格式。它广泛用于GitHub、Dev.to等许多平台,用于创建结构良好的文档,从README文件到博客甚至文档。在本教程中,我将向您介绍Markdown的基本知识—从基本语法到高级格式设置技术,这些技术将帮助您创建更专业、......
  • MongoDB配置文件详解--转
    一配置文件说明MongoDB有两种配置文件格式,分别是:3.2版官方yaml配置文件选项参考用=号的常规格式类似my.conf等常规配置的文件yaml语法的新格式mongodb3.x版本后就是要yaml语法格式的配置文件,下面是yaml配置文件格式如下:切记yaml只能使用空格,不支持tab键,切记配置举例配置......
  • Markdown学习
    Markdown学习标题:+空格+标题名字,几级标题就是几个#号,最多支持到六级二级标题三级标题六级字体Hello,world!两边加**变粗体Hello,world!两边加*变斜体Hello,world!两边加~~变删除Hello,world!两边加***变斜粗引用好好吃饭好好睡觉使用>分割线使用---、***......
  • 鸿蒙NEXT应用上架与分发步骤详解
    大家好,我是V哥。今天的文章来聊一聊HarmonyOSNEXT应用上架。当你开发、调试完HarmonyOS应用/元服务,就可以前往AppGalleryConnect申请上架,华为审核通过后,用户即可在华为应用市场获取您的HarmonyOS应用/元服务。HarmonyOS会通过数字证书与Profile文件等签名信息来保证应用的完......