降价

美好的一天，同事们！

经过漫长的学习历程，每个人都想向用人单位展示自己的成果，而且只展示最好的、最专业的一面，对吧？我想是的。因此，除了正确设计和实施项目之外，我们还需要能够将其形式化。雇主不会阅读你所有的项目代码来了解它的内容以及其中包含什么？在这篇文章中，我们最终将总结前两者，即：持续集成和代码覆盖率，并让我们在开源项目的“正面”表上了解我们在我们的项目中使用了什么以及它代表了什么。今天我们将和您谈论 Markdown，问我们最喜欢的问题：“它是什么？” 和“这是为什么？”，让我们弄清楚它的用途以及如何使用它。甚至会有一个例子，我们将在我们的开源项目中实现它。那么，我们走吧！

什么是“降价”？

由于你和我都是程序员，我们会立即去 Google 并打开第一个Wiki链接，上面写着： Markdown 是一种轻量级标记语言，其创建目的是编写最具可读性和易于编辑的文本，但适合转换为高级出版物的语言（HTML、富文本等）。 说到这里，说实话，我没什么可补充的，我想这已经是一个近乎完美的解释了。

为什么我们需要这个“Markdown”？

说实话，没有它实际上也不错 :D 但让我们记住我们的目标：编写一个有能力的项目模板，该模板已经具有持续集成并且具有 Codecov 资源的代码覆盖率统计信息。我为什么提到这一点？此外，Markdown 将允许我们从这些资源中获取数据并提供数据本身，或者将我们重定向到需要获取此信息的位置的徽章。将所有内容都放在一个“标题”页上而不是分散在不同的地方很方便，不是吗？

它用在哪里？

任何至少将其项目上传到 GitHub 一次的人都知道，GitHub 一直希望邀请您创建一个 README 文件：降价 - 2

该文件的扩展名是什么？没错，~~Bolt 懂~~Markdown！正如我们所知，该文件很容易调整为多种格式并转换为我们需要的 HTML。但我们慢慢来，不要急于立即将其直接添加到 GitHub。

如何使用它？

首先，您可能已经注意到，我们可以将其直接添加到 GitHub 中，这样就可以工作了！但例如，我们并不总是需要将其添加到一个项目中。或者例如，我们想更多地考虑如何创建它。而这里GitHub已经不再适合我们了。一般来说，我们创建 Markdown 文件不仅仅是为了将它们推送到 GitHub。其次，我们可以直接通过IDEA创建它，这正是我们要做的，但不是马上，因为为什么我们需要一个强大的开发环境来编写一个小文件？在这里，我建议浏览简单和不那么简单的 Markdown 文件编辑器的目录。就我自己而言，我选择了Haroopad，它非常简单、易于访问，可以即时表示您正在编写的内容（IDEA 也是如此），并且有语法提示。编辑器窗口如下所示：降价 - 3

在这里，我打开了我的一个项目的现成 README.md。左边是备忘单，右边是显示屏，中间是文本。一切都非常原始和简单。您还可以看到徽章，我们稍后会讨论。那些选择不同方式编写这些文件的人 - 不要惊慌，所不同的是图形界面。文本、语法和显示将保持不变。示例任务非常简单：编写 README.md，使其包含：有关项目的信息（包括徽章）、有关导入项目的信息、有关项目实施的信息、有关作者联系人的信息。正如我已经说过的，一切都非常简单和原始。我们开始谈正事吧。

让我们写一个标题——我们项目的名称。

使用哈希运算符“ # ”创建主要和最大的标题，然后写入标题。在我们的例子中：
```
# ForJavaRushPublication
```
然后我们写一个稍微小一点的标题，我们写“项目信息”。较小的标头前面有更多的“ # ”：
```
## Information
```
然后我们将编写有关该项目的信息。
让我们插入文章的链接。这样做非常简单，如果您使用 Haropad，那么只需输入备忘单，模板就会自行插入。语法为：“ [text](url) ”;
让我们插入徽章。让我们仔细看看这里。

首先，为了美观，我们将它们排列成表格的形式。将有2列和2列。语法看起来像这样：

结果会是这样的：

接下来，我们将在徽章中插入超链接，但是从哪里可以获得它们呢？在上一篇文章中，我展示了从哪里获取 Codecov，但我没有提及要获取哪个。既然我们有一个 Markdown 文件，我们还需要一个 Markdown Badge：

只需复制它并将其粘贴到我们的 Markdown 中的一列中即可。但不要忘记 Codecov 出现在 JaCoCo 分支中，但没有出现在 master 中，所以你必须手动更正它。Travis CI Badge 直接与项目名称相对应，其中构建日志为：

我们选择徽章，然后弹出设置窗口：

我们肯定选择 Markdown 以及您需要的分支。我将为两个分支制作 README.md，它们会略有不同，因为我尚未在 master 分支中实现 Codecov。

让我们编写有关如何导入或克隆该项目的信息。我不会解释如何做到这一点，但你可以在我的 README.md 中阅读它。我们将写下我们在项目中使用的技术，并放置它们的链接。尽管如此，这仍然是一个教育项目。好吧，我们把联系方式写下来吧。

我们的 Markdown 已经准备好了。我们所要做的就是将其添加到我们的项目中，然后就完成了。但不是一下子全部！让我们打开我们的 IDEA，然后在插件中检查您是否有 Markdown 支持：

我有Ultimate IDEA，所以我什么都有，你的插件可能默认没有安装，但是当你创建一个带有md扩展名的文件时，应该会提示你下载它。下载并重新启动您的 IDEA。