首页 > 其他分享 >基础markdown的编写格式

基础markdown的编写格式

时间:2024-10-31 19:46:42浏览次数:1  
标签:markdown 斜体 示例 转义 编写 格式 文本 下划线

所谓的.md文件,实际上就是markdown格式文本。因为在编写readme文档的时候需要使用这个格式进行编写,写devlog的时候也常使用.md转换成.rst格式然后进行编译,所以决定简单学习一下。
这里简单整理了一些markdown格式文本常用的格式符号的用法,包括标题,引用,代码块,表格,强调字体,删除下划线,转义符,以及脚注。

  1. 标题格式
    标题格式如图。标题格式有好几种写法,
    a. 第一种,用#键开头 空格 然后跟标题内容
    前面带#号,后面带文字,分别表示h1-h6,上图可以看出,只到h6,而且h1下面会有一条横线,注意,#号后面有空格
    image

a. 另一种表示方法如下
image

这种方法只能显示两级,再往下就是正文了。
a. 第三种表示方法:这个是闭合的符号
image

b. 两种方式可以混合使用,也就是说可以# 和====混合着写。它们都是转换成统一的html格式标签的。可以在写文档的时候随时观察预览效果
image

  1. 列表
    列表分为有序列表和无序列表。
    a. 有序列表是数字加点 后跟内容即可
    image

a. 无序列表可以用“*”,“+”, “-”来作为格式符号。可以混合使用。预览图如下:
image

  1. 引用和代码块
    如果想要标注出某段内容是引用摘抄等,可以添加引用格式符 >
    如果想在其中插入代码块,则使用符号''' '''进行标记,其中三引号但独占一行。
    image

  2. 分割线
    有***** ___ ----------,至少三个,有空格也可以。
    image

  3. 链接
    有两种方式,行内式和参数式。
    行内式的链接格式是:链接的文字放在[]中,链接地址放在随后的()中
    image

参数式的格式是:方括号里放标题,冒号后面写链接地址
image

  1. 图片
    图片也有两种表现方式,分别是行内式和参数式。和插入链接的方式几乎一样,只是在方括号前面加了一个!
    替代文本
    其中,替代文本:用于描述图片的文字,当图片无法显示时,会显示这段文本。
    其中, 图片链接:指向图片的URL或本地路径。
    如果你想插入一张网络上的图片,可以这样写:
    image

如果你想插入一张存储在本地的图片,比如在同一目录下的 image.png,可以这样写:
image

我的图片

注意事项

  • 确保图片链接有效,否则图片不会显示。
  • 在本地使用时,确保文件路径正确。
  1. 表格
    在Markdown中创建表格的基本格式如下:
    | 列1 | 列2 | 列3 |
    |-------|-------|-------|
    | 行1-1 | 行1-2 | 行1-3 |
    | 行2-1 | 行2-2 | 行2-3 |

说明

  • 第一行是表头,用 | 分隔不同的列。
  • 第二行使用 - 来定义每一列的对齐方式,至少要有三个 -。可以在 : 的左边或右边添加空格来调整对齐:
    • :--- 表示左对齐
    • :---: 表示居中对齐
    • ---: 表示右对齐

示例

| 名字   | 年龄 | 职业   |
|--------|------|--------|
| 小明   | 25   | 教师   |
| 小红   | 22   | 学生   |
| 小刚   | 30   | 工程师 |

渲染效果

名字 年龄 职业
小明 25 教师
小红 22 学生
小刚 30 工程师

通过这种方式,你可以轻松创建整齐的表格。
冒号得用英文的
image

  1. 强调转义删除线
    在Markdown中,强调、转义和删除线的表示方式如下:

1. 强调

  • 斜体:用单个星号或下划线包围文本。
    • 示例:*斜体*_斜体_
  • 粗体:用两个星号或下划线包围文本。
    • 示例:**粗体**__粗体__
  • 粗斜体:用三个星号或下划线包围文本。
    • 示例:***粗斜体***___粗斜体___

image

2. 转义

要在Markdown中插入特殊字符,可以使用反斜杠 \ 进行转义。

  • 示例:\*转义的星号\* 会显示为 *转义的星号*(在前面只要加斜杠就可以显示原本的符号了
    image

3. 删除线

使用两个波浪线包围文本。

  • 示例:~~删除线~~
    image
  1. 下划线和脚注:
    image

常见的基本都写在这里了。不常见的自己问chatgpt吧

标签:markdown,斜体,示例,转义,编写,格式,文本,下划线
From: https://www.cnblogs.com/sweetpotatoincorner/p/18518755

相关文章

  • Markdown学习
    Markdown学习(一级标题,1个#号加空格)二级标题(2个#号加空格)三级标题(3个#号加空格)四级标题(4个#号加空格)字体Helloworld!加粗(加粗:前后各加双*号)Helloworld!斜体(斜体:前后各加单*号)Helloworld!加粗+斜体(加粗+斜体:前后各加三*号)删除线(删除线:前后各加双......
  • 以execl格式导出账单列表
    这个过程主要分为数据处理、Excel文件生成、文件响应给客户端等关键步骤。1.准备数据源首先获取要导出的账单数据,从数据库中查询数据并将其封装为对象列表(如List)。每个对象代表一条账单记录,字段包含账单日期、金额等。List<Bill>billList=billService.getAllBills();2.......
  • Adobe Media Encoder 2025 v25.0 (macOS, Windows) - 格式转换
    AdobeMediaEncoder2025v25.0(macOS,Windows)-格式转换Acrobat、AfterEffects、Animate、Audition、Bridge、CharacterAnimator、Dimension、Dreamweaver、Illustrator、InCopy、InDesign、LightroomClassic、MediaEncoder、Photoshop、PremierePro、AdobeXD请访问......
  • Adobe InCopy 2025 v20.0 (macOS, Windows) - 编写和副本编辑软件
    AdobeInCopy2025v20.0(macOS,Windows)-编写和副本编辑软件Acrobat、AfterEffects、Animate、Audition、Bridge、CharacterAnimator、Dimension、Dreamweaver、Illustrator、InCopy、InDesign、LightroomClassic、MediaEncoder、Photoshop、PremierePro、AdobeXD请......
  • NVMe SSD格式化到底做了什么?
     无论是为了防止数据泄露,还是更改硬盘格式,我们通常会进行格式化操作。在Windows或Linuxshell中对SSD进行格式化(format)时,往往需要几分钟甚至几十分钟,这个时间通常与硬盘容量成正比。那么在这段时间里,SSD到底做了些什么操作呢?为更好地理解本文,这里需要介绍一些SSD的工作原理。......
  • 编写高性能爬虫抓取股票行情数据
    最近给一个私募大佬帮忙做了一些股票交易有关的系统,其中涉及到行情数据抓取的问题,一番摸索之后,把成果在这里做个分享。我把行情抓取的部分,和一个写手记的小功能,单独拿了出来放在一个小系统里面,可以免费使用:https://rich.shengxunwei.com/先简单介绍下这个小系统的样子,然后我会详......
  • java Web 时间LocalDateTime 输出到前端格式化
    格式化时间返回到前端 packagecom.za.edu.config;importcom.fasterxml.jackson.databind.DeserializationFeature;importcom.fasterxml.jackson.databind.ObjectMapper;importcom.fasterxml.jackson.databind.module.SimpleModule;importcom.fasterxml.jackson.datab......
  • golang编写代码发邮件
    AI提示词用go语言直接向mx记录的25端口发邮件,要采用STARTTLS连接方式,要包含Message-IDpackagemainimport("crypto/tls""fmt""log""math/rand""net""net/mail""net/smtp""st......
  • 无人机避障——2D栅格地图pgm格式文件路径规划代码详解
    代码和测试效果请看上一篇博客:无人机避障——使用三维PCD点云生成的2D栅格地图PGM做路径规划-CSDN博客 更换模型文件.dae:部分模型文件可以从这里下载:https://github.com/ethz-asl/rotors_simulator/wiki将原先代码中的car.dae文件更换为无人机.dae文件然后对urdf文件进......
  • Python数据分析NumPy和pandas(十七、pandas 二进制格式文件处理)
    以二进制格式存储(或序列化)数据的一种简单方法是使用Python的内置pickle模块。同时,pandas构造的对象都有一个to_pickle方法,该方法以pickle格式将数据写入磁盘。我们先把之前示例用到的ex1.csv文件加载到pandas对象中,然后将数据以二进制pickle格式写入examples/frame_p......