什么是 README.md 文件？

README 文件是必不可少的指南，它为其他开发人员提供了您的 GitHub 项目的详细描述。

您可能想知道，为什么任何人都应该花时间编写 README 文件。好吧，这里有一些理由可以帮助您相信这是一个好主意：

一个好的 README 可以帮助你的项目从其他项目中脱颖而出，并且应该和你的项目本身一样好。
这是遇到您的项目时首先要注意的事情，因此它应该非常简短但详细。
自述文件描述的质量将好项目与坏项目区分开来。
很多时候 README.md 作为网站托管；确保您的网页看起来和您的项目一样酷！

自述文件的内容：

以下是自述文件的一般关键组件：

包括您的项目的标题：这是项目的名称。它用几句话描述了整个项目，并帮助人们理解主要目标和目的。
写描述：你的描述是你项目的重要组成部分。维护良好的描述可以让您向其他开发人员和潜在雇主展示您的工作。
如何使用您的项目：提供说明和示例，以便用户或贡献者可以使用该项目。这将使他们更容易，因此如果他们遇到问题，他们将始终有一个参考的地方。
包括学分：如果您作为一个团队参与过该项目，请列出您的团队成员。您还应该包括他们的 GitHub 个人资料。

您还可以在自述文件中添加以下详细信息：

你的动机是什么？你为什么要建立这个项目？
项目解决了什么问题？或者，它有什么作用？
为什么你使用特定的技术？如果您的项目有很多功能，请在此处列出。
提及您面临的一些挑战以及您希望在未来实现的功能。
提及您认为自己为在该项目中构建或拥有的任何东西而感到自豪
在这个过程中你学到了什么？
该项目的下一步是什么？
提及语言、框架、数据库等。
提供部署链接或任何其他所需链接

在深入研究我们项目的自述文件之前，让我们先讨论一下 Markdown 语言。

降价

Markdown 是一种轻量级标记语言，它允许我们使用典型的格式化技术（如标题、强调、列表、图像和链接）来设置数字文本文档的样式。
Markdown 文件具有扩展名 .md 或 .markdown 。我们可以将 Markdown 转换为 XHTML 或 HTML，以便在浏览器中很好地显示。
Markdown 的许多用途包括：

自述文件
在在线讨论论坛上写消息
使用纯文本编辑器、电子邮件和技术文档创建富文本。

使用 Markdown 的热门网站包括 GitHub、Trello、Reddit、SourceForge 和 StackExchange。
如果您想要实现更复杂的设计，Markdown 解析器还支持添加 HTML 代码块，这些代码块会添加到 Markdown 的有限语法中。

我们为什么要使用 Markdown？

非技术作家更容易制作既具有协作性又具有灵活性的文档。
易于上手——它具有我们大多数人已经接触过的电子邮件格式约定的基础。
与充满标签的 HTML 不同，易于阅读（在其原始状态下）。
平台无关——这意味着您可以在任何文本编辑器中创建 Markdown 文件。
可重用技能：它用途广泛，我们可以用它来做笔记、为网站创建内容或制作可打印的文档。

现在，让我们讨论一下markdown语言的元素。

1. 标题：

标题使您的文本更具可读性，并有助于分解主题。
在 Markdown 中，标题在包含标题的行前面用井号 (#) 格式化。
您最多可以使用六个散列，散列的数量对应于标题级别。

句法：

# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6

格式化文本：

2. 段落：

将您的信息分成几段（每段之间有明显的间隔）。
段落由连续段落之间的空白行（不包含字符的行）分隔。

句法：

Paragraph 1
Paragraph 2

3.换行：

通过插入比格式化为段落所获得的空间更少的新行来拆分信息。它被称为换行符。
要在 Markdown 文件中插入换行符，请至少用两个空格完成您的行，然后按回车键。它将为您的文本呈现一个新行。

句法：

Line 1  
Line 2

4. 斜体：

在每一侧用一个星号/下划线包裹该项目。

例子：

*one star on each side*
_This text is also italic_

格式化文本：

one star on each side
This text is also italic

5. 粗体：

在每边用两个星号/下划线包裹物品。

例子：

**two stars on each side**
__This text is also bold__

格式化文本：

two stars on each side
This text is also bold

6. 同时粗体和斜体：

使您的文本同时粗体和斜体，使其更加重要！
使用三个星号（或三个下划线）来包裹您的单词或短语。

例子：

***This text is italic and bold.***
___This text is also italic and bold.___

格式化文本：

This text is italic and bold.
This text is also italic and bold.

7. 击穿：

将物品包裹在每侧的两个波浪号中。

例子：

~~strikethrough~~

格式化文本：

8. 链接：

要在 Markdown 内容中链接到外部网站，请使用两组括号。
将链接文本括在括号 [ ] 中，然后将 URL 括在括号 ( ) 中：[ ]( )。

例子：

[This text links to gfg](https://write.geeksforgeeks.org/).

格式化文本：

This text links to gfg

9. 图片：

在 Markdown 文件中插入图像类似于链接的格式。
以感叹号开始您的图像格式。接下来，使用方括号将您的图片替换文字包裹起来，紧挨着包含图片 URL 的括号。
确保感叹号、方括号或圆括号之间没有空格。
当您的 Markdown 文件呈现为 HTML 时，它会将图像直接嵌入到正文中。

例子：

![image](https://media.geeksforgeeks.org/wp-content/cdn-uploads/20210914130327/100-Days-of-Code-with-GFG-Get-Committed-to-a-Challenge.png)

格式化图像：

10. 无序列表：

Markdown 允许您使用几种不同的符号来格式化列表：星号 (*)、连字符 (-) 或加号 (+)。
您可以选择您喜欢的符号。你得到的结果是一样的。

句法：

-Just add a dash first and then write a text.

-If you add another dash in the following line, you will have another item in the list.
    - If you add four spaces or use a tab key, you will create an indented list.
        - If you need sert an indenta list within an intended one, just press a tab key again.

Sometimes you want bullet points:

*Start a line with a star 
*Profit!

输出：

11.有序列表：

通过在每个列表项前加上一个数字、后跟一个句号和一个空格来格式化您的有序列表。
在 Markdown 中，使用哪个数字来格式化列表并不重要，因为列表将始终呈现为 1、2、3 等。

例子：

1. Just type a number follow by a dot.
2. If you want to add a second item, just type in another number followed by a dot.
1. If you make a mistake when typing numbers, fear not, Markdown will correct for you. 
    1. If you press a tab key or type four spaces, you will get an indented list and the numbering will start from scratch.
        1. If you want to insert an indented numbered list within an existing indented numbered one, just press the tab key again. 
            -If need be, you can also add an indented unordered list within an indented numbered one, by pressing a tab key and typing adash.

格式化文本：

12. 块引用：

有时在 Markdown 中，我们会希望使用引号引用外部源。它被称为块引用。
您可以通过在块引用的第一行前面加上大于号或尖括号 (>) 来表示任何块引用。

例子：

> This is a blockquote
> This is a blockquote
> This is a blockquote

格式化文本：

13、横向规则：

水平线是一个很小的功能元素，您可以使用它来直观地拆分 Markdown 文件中的文本块。
我们用三个或更多连字符 (-)、星号 (*) 或下划线 (_) 来表示水平线。

例子：

---
* * *
___

格式化文本：

14. 代码片段：

要将代码片段作为示例引用，请使用包含您的代码片段的反引号 ` 来格式化代码片段。
第一个反引号“打开”片段，第二个反引号“关闭”它。

例子：

`This is a code snippet.`

格式化文本：

15. 代码块：

当您有更大的代码块要包含在 Markdown 文件中时，格式化代码块很有用。
通过使用一个制表符或四个空格缩进代码块的每一行来格式化代码块。
如果你想使用语法高亮，包括语言。

例子：

```javascript

if (isAwesome){

 return true

}

```

格式化文本：

16.逃脱：

在 Markdown 中，您通常需要在文本中包含可能是 Markdown 语法一部分的字符（例如，星号）。
您需要“转义”这些字符，因此您的 Markdown 应用程序不会将这些字符读取为格式。
在 Markdown中使用字符前的反斜杠转义字符，中间没有空格。

句法：

\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash symbol
+ plus sign
– minus sign (hyphen)
. dot
! exclamation mark

格式化文本：

17. 块引用中的列表：

将列表格式嵌套在块引用格式中。
使用大于号 (>) 后跟一个空格来格式化您的块引用，包括块引用的每一行之前的符号。
在大于号之后添加列表格式 (*)。

例子：

> This is a blockquote
> * This is a list item within a blockquote
> * This is a list item within a blockquote
> * This is a list item within a blockquote

格式化文本：

18. 行情：

在每行的开头添加一个带有 >字符的引号。

例子：

> "I make Jessica Simpson look like a rock scientist."

> —Tara Reid, actress

格式化文本：

由于我们正在讨论 GitHub 存储库中存在的readme.md ，所以让我们讨论 GitHub Flavored Markdown！

GitHub 风格的 Markdown

GitHub.com 使用它的 Markdown 语法版本，它提供了一组额外的有用功能，其中许多功能使处理 GitHub.com 上的内容变得更加容易。
请注意，GitHub Flavored Markdown 的某些功能仅在 Issues 和 Pull Requests 的描述和评论中可用。
这些包括@提及以及对问题和拉取请求的引用。

1.语法高亮：

突出显示语法。

例子：

格式化代码：

2. 任务列表：

创建任务列表
如果您在问题的第一条评论中包含任务列表，您将在问题列表中获得方便的进度指示器。
它也适用于拉取请求。

例子：

- [x] @mentions, #refs, [links](), **formatting**, and tags supported
- [x] list syntax required (any unordered or ordered list supported) 
- [x] this is a complete item 
- [ ] this is an incomplete item

格式化文本：

3. 表格：

您可以通过组合单词列表并用连字符 - （对于第一行）将它们分隔，然后用竖线 (|) 分隔每一列来创建表格。

例子：

First Header | Second Header 
 ------------ | ------------- 
Content from cell 1 | Content from cell 2 
Content in the first column | content in the second column

格式化文本：

4. 用户名@提及：

键入 @ 符号，后跟用户名，将通知该人来查看评论。
这被称为“@提及”，因为您提及的是个人。
您还可以@提及组织内的团队。

5. 自动链接网址：

任何 URL（如 http://www.github.com/）都会自动转换为可点击的链接。

既然现在你已经知道了关于readme.md 的一切，下次你创建一个存储库时不要忘记在你的项目中添加一个完美的自述文件！