关于README

采用github管理项时经常会需要编写README文档，在编写README文件时最常用的方式就是直接在vscode中来编辑，本文从图片、表格和链接跳转几个方向来讲解README的编辑方式。

在之前的项目中我发现，Typora只适合编写单篇文章，太长的话会特别卡，后来更多采用vscode编辑来进行README的编写。

首先，一个 README 文件通常是一个文本文件，位于项目的顶级目录下，用于向其他人介绍和解释项目的内容、结构和使用方式。README 文件的目的是帮助用户和开发者快速了解项目，并提供必要的指导和信息。

通常，README 文件包含以下内容：

1. 项目描述：简要描述项目是做什么的，项目的目标和意图。

2. 安装说明：如果项目是一个软件工具或应用程序，提供安装步骤和所需的依赖项。

3. 使用方法：提供项目的使用说明，包括如何运行、配置或部署项目。

4. 示例：如果可能的话，提供示例或演示，以便用户更好地理解项目的功能和用途。

5. 贡献指南：如果项目是开源的，通常会包括如何贡献代码或参与项目的指南。

6. 作者信息：包括项目的作者或贡献者的联系方式或个人简介。

合理清晰的README可以帮助读者快速的介入和采取项目。

图片编辑

首先我们需要明白，无论是使用我们自己的本地图片还是采取url的方式来获取图片，我们都需要有一个图床来承载图片，当我们从本地上传的时候就需要在自己的本地文件夹下搭建一个用于保存图片的文件夹

在这里assets就是图片文件夹，里面存放相关图片。

接着来引用图片：

• 直接引用：

![text](./assets/xxx.jpg)

• 如果需要调整图片的大小和位置，可以采用另一种使用方法：

<div align="center">
  <img src="./assets/xxx.png" width="80%">
</div>

这里是采用HTML和Markdown混合编写的，实现了在README中居中显示一张图片，并设置了图片的宽度为80%。

<div align="center">...</div>: 这是一个<div>元素，使用了align="center"属性来将其内容水平居中显示。

<img src="./assets/xxx.png" width="80%">: 这是一个<img>标签，src属性指向图片的路径（相对路径"./assets/xxx.png"），width属性设置图片显示宽度为80%。

在README文件中，可以使用这样的HTML标记来实现更复杂的布局或样式。但是，并非所有的Markdown解析器都支持HTML标签。

引用链接

采用以下格式链接，可以链接本地其他文件进行跳转，也可以跳转至网页，这里以我的主页为例子，跳转到一个网页：

[link to a webpage](https://blog.csdn.net/qq_61508298?spm=1018.2226.3001.5343)

[Connect to local device](./xxx.md)

表格编辑

在 Markdown（*.md）文件中，当您选择一个完整的表格时； 右键单击所选的 Markdown 表格来打开上下文菜单。 将看到：

表格：

| aaaa | bbbb | cccc |  |
|--:|---------|:--:|:----|
||         |  |         |
|     |  |         |   a value      |
||         |         |         |
|     |         | This is a long value |       but why? |
|     |         |         |         |
|     |                                           |         | Here is something |
|  |         |   |         |

 如果希望表格内换行，我们可以采用加入HTML和Markdown混合编写：

|111 <br> 222  <br> 333  <br> 444|

最后的输出会在表格内产生分行。

代码放置

代码块通过两行 ``` 符号框出，如果你写的代码是某种语言，那么可以在第一行末尾加上这个语言的名字，代码块内的代码就会执行对应的高亮语法：

行内代码引用：正文中的代码，则通过输入`` 框出：

use `rostopic pub /FirstTaskFilter std_msgs/String "test"`, `sendMessage`

以上就是VScode下markdown的编辑方式，如果还有觉得需要加入的内容，可以留言，有空看到会更新。