原文:【github】論怎么去寫一個高大上的ReadMe

前言 以前我時常覺得,自己寫的ReadMe很單調乏味,但后來仔細研究一下后,發現有很多方式可以讓ReadMe在簡潔的基礎上變得好看些,所以在這里和大家分享,如果大家有更好的想法,也非常歡迎在評論區留言哦 美化方案 加彩色徽章:介紹npm版本,證書類型,發布版本等 給代碼添加顏色,不要使用純文本啦 給自己的代碼庫設計一個專屬的logo 有想到再加其他的 最終結果 Github地址 https: gi ...

2019-09-09 08:02 9 942 推薦指數:

查看詳情

如何一個優秀的GitHub項目README文檔?

今天給大家介紹一個Github上的README文檔寫作教程模版,該模版目前獲得6634顆星星,2296Fork,相對而言,還是比較得到大家認可的。不花哨,不別出心裁,一個比較實用的,普適性的架子;所謂教科書式,不外如此。原文是英語,大神可直接看戳我查看。下面是我翻譯的中文版(未完全按照原文翻譯 ...

Thu Jan 24 18:02:00 CST 2019 0 649
如何一個通用的README規范

背景 我們平常在進行項目開發時,一般都會把代碼上傳至代碼托管平台上方便管理和維護。目前我廠使用的托管平台是SVN,國內外還有一些比較知名的代碼托管平台,比如github、Gitlab、BitBucket,碼雲和碼市等。 但我們在多人合作開發下,經常碰到的最頭疼的問題是,其他開發者 ...

Wed May 02 05:36:00 CST 2018 0 3806
GitToc-為你的Github倉庫的Readme自動生成一個目錄

維護自己的Github倉庫的時候發現GithubReadme不支持Toc目錄,所以就自己寫了一個小工具。 工具地址:https://github.com/Holy-Shine/GitToc 簡介 如下是轉換效果: 轉換后的目錄支持頁內跳轉 使用教程 假設你的目標文件名 ...

Fri May 17 22:27:00 CST 2019 0 642
Github 個人首頁的 README,這樣玩兒~

本文首發於 Ficow Shen's Blog,原文地址: Github 個人首頁的 README,這樣玩兒~。 內容概覽 前言 創建倉庫 修改 README 的內容 總結 前言 大家最近有沒有發現這個現象,有些名人的 Github 首頁變得 ...

Wed Sep 23 17:04:00 CST 2020 6 938
GITHUB readme基本語法

而不讓其轉化為大標題,則需要在兩者之間加一個空行。 另一種方法:(推薦這種方法;注意中間需要有一個 ...

Mon Sep 30 00:11:00 CST 2019 0 776
githubReadMe語法

大標題 =================================== 大標題一般顯示工程名,類似html的\<h1\>< ...

Tue May 15 23:19:00 CST 2018 0 896
如何在Github上用Markdown寫好ReadMe

MarkDown的基本語法(可以直接復制下述內容到githubreadme.md顯示結果) 一、標題寫法:第一種方法:1、在文本下面加上 等於號 = ,那么上方的文本就變成了大標題。等於號的個數無限制,但一定要大於0個哦。。2、在文本下面加上 下划線 - ,那么上方的文本就變成了中標 ...

Fri Apr 26 00:42:00 CST 2019 0 481
關於githubreadme編輯的方法

實驗室的老師昨天改完論文發我后,說按照例子改。於是才發現githubreadme編輯滿滿的極客思維。 看了一下csdn給的教程 https://blog.csdn.net/Kaitiren/article/details/38513715 連圓點都用轉義字符星號控制了:本地化自有化的思維 ...

Sun Sep 09 00:14:00 CST 2018 0 1686
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM