降價

美好的一天，同事們！

經過漫長的學習歷程，每個人都想向雇主展現自己的成果，而且只展現最好的、最專業的一面，對嗎？我想是的。因此，除了正確設計和實施專案之外，我們還需要能夠將其形式化。雇主不會閱讀你所有的專案代碼來了解它的內容以及其中包含什麼？在這篇文章中，我們最終將總結前面的兩個，即：持續整合和程式碼覆蓋率，並讓我們在開源專案的「正面」表上了解我們在我們的專案中使用了什麼以及它代表了什麼。今天我們將和您談論 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。