Github上的Markdown语法详解

news2024/11/27 14:42:49

今天在看Win32文档参与编写的说明时,看到里面提及

Our documentation is written in Markdown, a lightweight text style syntax. If you're not familiar with Markdown, you can learn the basics on GitHub. When unsure,

刚好,今天就来做个全面的总结 ,以后在github上写说明的时候,就更方便了。


标题

输入 # 空格 文本,就可以创建标题,如:

# 一级标题

一级标题

## 二级标题

二级标题

### 三级标题

三级标题

文本样式

样式语法快捷键示例输出
加粗** ** 或者 __ __Ctrl+B**加粗**加粗
斜体* * 或者 _ _Ctrl+I*斜体*斜体
删除线~~ ~~~~删除文本~~删除文本
加粗嵌套斜体** ** 和 _ _**加粗中的_斜体_**加粗中的_斜体_(博客园Markdown编辑器不支持这种格式,看不到显示效果)
加粗并斜体*** ******加粗并斜体***加粗并斜体
下标普通文本<sub>下标</sub>普通文本下标
上标普通文本<sup>上标</sup>普通文本上标

引用文本
输入 > 空格 引用文本

> 引用文本

引用文本

引用代码
输入 'code' 或 ```code```

Hello `World`

Hello World

```
Hello World
```

Hello World

语法高亮

在 ```后输入语言名称即可,完整的语言列表可以访问 https://github.com/github/linguist。

```
Console.WriteLine("HelloWorld");
```

Console.WriteLine("HelloWorld");

```c#
Console.WriteLine("HelloWorld");
```

Console.WriteLine("HelloWorld");

颜色显示(支持 issues, pull requests, 和 discussions,说明文档是不支持这种语法格式的)

颜色模式语法示例输出
HEX#RRGGBB红色`#ff0000`红色ff0000
RGBrgb(R,G,B)黑色`rgb(0, 0, 0)`黑色rgb(0, 0, 0)
HSLhsl(H,S,L)白色`hsl(216, 0%, 100%)`白色hsl(216, 0%, 100%)

超链接
输入 [显示内容](链接地址)

[博客园](https://www.cnblogs.com)

博客园

链接到段落

如果我们想链接到文中的某一个位置。如下图所示。可以复制前面那个链接图标的地址

然后创建一个链接,如下:

[实用工具](https://github.com/zhaotianff/Master-Zhao#实用工具)

实用工具

链接到项目文件

如果我们想链接到项目中的某一个文件,直接指定相对路径即可。以当前md文档所在的路径为根目录。./为当前目录, ../为上级目录../../为上上级目录,依此类推。xx/./xx/为当前路径下的xx目录,a/b./a/b为当前a目录下的b目录,依此类推。
比如常用的开源协议文件,一般都会创建一个这样的链接,代表链接到当前路径下的LICENSE文件

[CC0-1.0](./LICENSE).

[CC0-1.0](LICENSE).

图片
输入 ![替代文本](图片地址) 就可以插入图片,图片地址可以是一个网络地址,也可以是当前项目下的。

![alt text](https://img2.baidu.com/it/u=3155456000,3342398460&fm=253&fmt=auto&app=138&f=JPG?w=387&h=500)

alt text

![logo](icon/logo.png)

但是这种方式有个缺点,就是图片不能居中,如果想要图片居中,可以使用p和img标签

<p align="center">
    <img alt="alt text" src="https://img2.baidu.com/it/u=3155456000,3342398460&fm=253&fmt=auto&app=138&f=JPG?w=387&h=500" />
</p>

alt text

列表
输入 * 空格 列表项 或 - 空格 列表项

* 列表项1
* 列表项2
  • 列表项1
  • 列表项2
- 列表项1
- 列表项2
  • 列表项1
  • 列表项2

列表嵌套

列表嵌套也是使用跟创建列表一样的语法,但是嵌套符号要和上级列表的首字符对齐。
如嵌套列表的*是和上面的"列"字是对齐的

* 列表
  * 嵌套列表1
    * 嵌套列表2
  • 列表
    • 嵌套列表1
      • 嵌套列表2

数字列表

也可以创建数字列表,输入 数字. 空格 列表项
如:

1. 列表项1
2. 列表项2
   * 嵌套列表项
  1. 列表项1
  2. 列表项2
    • 嵌套列表项

任务列表
使用 - [x] 任务描述 创建一个完成项,使用 - [ ] 任务描述 创建一个未完成项。

- [x] 已完成
- [ ] 未完成
- [ ] https://github.com/TianXiaTech/BlurWindow/issues/2
  • 已完成
  • 未完成
  • https://github.com/TianXiaTech/BlurWindow/issues/2

使用emoji
输入 :emoji代码: 就可以插入emoji
如:

:+1::+1:

👍👍

添加脚注
输入 [^脚注名称] 和 [^脚注名称]:说明 创建一个脚注

测试脚注[^1]

[^1]:脚注说明

实际效果

测试脚注[1]

注释
输入 "<!--需要注释的内容-->"

忽略Markdown格式
在Markdown标记字符输入 \ 即可

如:

# 一级标题
\# 一级标题

一级标题

# 一级标题


  1. 脚注说明 ↩︎

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2206911.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

PyCharm 项目解释器切换指南:如何在项目中更换 Python Interpreter

PyCharm 项目解释器切换指南&#xff1a;如何在项目中更换 Python Interpreter 文章目录 PyCharm 项目解释器切换指南&#xff1a;如何在项目中更换 Python Interpreter一 Settings 设置二 Project 选项三 Conda Environment四 更换 Environment 本文详细介绍了在 macOS 系统中…

02复写零

复写零 我们先进行异地复写&#xff1a;代码如下 public class Test {public static void main(String[] args) {int []array {1,0,2,3,0,4};duplicateZeros(array);}public static void duplicateZeros(int[] arr) {int [] elemnew int[arr.length];for(int cur0,dest0;des…

鼠标市场洞察:数据分析揭示消费趋势!

鼠标整体数据分析 一. 概述 本报告基于从淘宝商品搜索接口和淘宝精确月销量接口中提取的数据&#xff0c;分析了前百个品牌在销售额上的占比情况。分析涵盖了销售额和占比的数据&#xff0c;为决策提供了依据。(以上两个接口有需求的可以找我要链接&#xff09; 1. 大盘整体…

linux 安装gitlab

安装环境 CentOS 7.7 (centos6.10会报错)2g内存防火墙关闭 安装步骤&#xff1a; 1 安装gitlab # yum install -y git curl policycoreutils-python openssh-server # 安装依赖 # wget https://mirrors.tuna.tsinghua.edu.cn/gitlab-ce/yum/el7/gitlab-ce-10.2.2-ce…

Lucene 倒排索引

倒排索引是什么&#xff1f; 【定义】倒排索引&#xff08;Inverted Index&#xff09;是一种用于信息检索的数据结构&#xff0c;尤其适用于文本搜索。它与传统索引的主要区别在于&#xff0c;传统索引是根据文档来查找词语的位置&#xff0c;而倒排索引则是根据词语来查找文…

【云从】三、计算机网络基础

文章目录 1、网络2、网络通信2.1 IP地址2.2 子网掩码2.3 网关2.4 私有地址和公有地址2.5 NAT网络地址转换 3、网络架构及设备 1、网络 网络&#xff0c;即通过通信线路&#xff08;如光纤、网线&#xff09;和通信设备&#xff08;如路由器、光猫&#xff09;&#xff0c;将各…

切换按钮组动画效果

<!DOCTYPE html> <html lang"zh"><head><meta charset"UTF-8"><meta name"viewport" content"widthdevice-width, initial-scale1.0"><title>按钮切换动画</title><style>body {disp…

【隐私计算】隐语HEU同态加密算法解读

HEU: 一个高性能的同态加密算法库&#xff0c;提供了多种 PHE 算法&#xff0c; 包括ZPaillier、FPaillier、IPCL、Damgard Jurik、DGK、OU、EC ElGamal 以及基于FPGA和GPU硬件加速版本的Paillier版本。 本文我们会基于GPU运行HEU Docker容器&#xff0c;编译打包GPaillier并测…

C++常用库函数

大小写转换 islower/isupper函数 用于检查一个字符是否为小写或大小字母&#xff0c;需要包含头文件< cctype >,也可以包含万能头文件< bits/stdc.h >.函数返回值类型为bool类型。 int main() {char ch1 A;char ch2 b;//使用islower函数判断是否为小写字母if …

springboot+react实现移动端相册(上传图片到oss/ 批量删除/ 查看图片详情等功能)

相册页面及功能展示&#xff1a; react前端结构及代码&#xff1a; Java后端结构及代码 数据库结构&#xff1a; photo&#xff1a; user 这是首个利用AI自有知识构建的简易相册系统&#xff0c;项目是react构造前端spring boot构造后端。 前端有四个主要页面&#xff1…

深入理解Transformer的笔记记录(精简版本)NNLM → Word2Vec

文章的整体介绍顺序为: NNLM → Word2Vec → Seq2Seq → Seq2Seq with Attention → Transformer → Elmo → GPT → BERT 自然语言处理相关任务中要将自然语言交给机器学习中的算法来处理,通常需要将语言数学化,因为计算机机器只认数学符号。向量是人把自然界的东西抽象出…

MySQL创建电子订阅表相关指令(创建,删除,查询,说明,添加)

利用以下代码创建一个名字为one的数据库。 查看数据库是否创建完成 。 创建一个在one数据库中的表格&#xff0c;括号里是字段名和数据类型&#xff0c;用逗号隔开&#xff0c;给id设置主键&#xff0c;确保id的唯一性。 INSERT INTO 为添加数据&#xff0c;one.subscribe中o…

第 1 章 MyBatis快速入门

1.1 ORM简介 ORM&#xff08;Object Relational Mapping&#xff0c;对象——关系映射&#xff09;框架的主要功能是根据映射配置文件&#xff0c;完成数据在对象模型与关系模型之间的映射&#xff0c;同时出屏蔽了连接数据库、创建 Statement 对象、执行 SQL、读取 ResultSet…

DSP 如何在调试时便捷查看数组元素

背景描述: 在CCS调试过程中&#xff0c;需要查看一些变量的值&#xff0c;但是数组只能显示第一个元素的值&#xff0c;不能全部展示出来&#xff0c;这样就不便于查看了。 解决方法: 找到变量显示窗口 选中数组右键 设置开始元素和需要展示的个数 这样就可以把数组展开…

Java->Map和Set

目录 一、搜索树 1.概念 2.查找 3.插入 4.删除 二、搜索 1.Map的使用 1.1关于map的说明 1.2map的常用方法 2.Set的使用 2.1关于set的说明 2.2set的常用方法 三、哈希表 1.概念 2. 哈希冲突 3.冲突避免 3.1哈希函数的设计 3.2负载因子调节 4.解决冲突 4.1闭…

3 机器学习之假设空间

归纳(induction)与演绎(deduction)是科学推理的两大基本手段。前者是从特殊到一般的“泛化”(generalization)过程&#xff0c;即从具体的事实归结出一般性规律&#xff1b;后者则是从一般到特殊的“特化”(specialization)过程&#xff0c;即从基础原理推演出具体状况。例如&a…

一款功能强大的颜色选择工具ColorPicker

ColorPicker 是一款轻量级且功能强大的颜色选择工具&#xff0c;专为设计师、开发者以及需要在日常工作中处理颜色的用户设计。该工具允许用户从屏幕上的任意位置快速获取颜色代码&#xff0c;并提供多种格式的颜色值输出&#xff0c;包括RGB、HEX、HSB等。 ColorPicker的界面…

YOLO的相关改进机制

我的面包多平台有多种关于YOLO的改进&#xff0c;大家尽早关注&#xff0c;不迷路

opencv 答题卡检测项目实现

在教育和考试领域&#xff0c;答题卡自动评分系统能够大大提高效率和准确性。本文将介绍如何使用OpenCV库实现一个简单的答题卡检测项目。这个项目包括读取图像、检测答题卡轮廓、透视变换、二值化处理、检测选择题答案&#xff0c;并最终计算得分。 导入库和定义常量 import …

动态规划-路径问题——931.下降路径最小和

1.题目解析 题目来源&#xff1a;931.下降路径最小和——力扣 测试用例 2.算法原理 1.状态表示 我们可以开辟一个dp表&#xff0c;多开辟一行两列用来存储虚拟位置&#xff0c;dp[i][j]表示从第一行到该位置的最小路径和 2.状态转移方程 由于要找到最小路径和&#xff0c;并且由…