第四章(进阶1) 如何书写Markdown/README.md
深入学习的阅读资料:
我无意于重复已经存在的教程信息,只准备简单列出本次培训中各位所需要知道的精简信息。 如果你有兴趣,请移步阅读资料中的超链接,更加系统性地进行学习。
- 本章你将了解到如何书写Markdown。以及如何在Github上写一份好看的
README.md
文件。
Markdown语法
Markdown是一种快捷式的标签语言,如果有同学写过HTML,对这玩意应该非常之熟悉。
正因为其本质上基于HTML,因此HTML标签也是可以共存的,例如:<h1>一级标题</h1>
与 # 一级
是完全等价的。
关于Markdown,你们可以找到现成的学习资料:Mastering Markdown,我就不再次重复这个过程了。
本篇将致力于告诉你如何使用Markdown语言书写一份好看的README.md
文件
什么是 README.md
README.md
是有关本项目的总览,是其他人首次接触本项目对本项目的第一印象。一份好的README.md
可以让人对你的项目更感兴趣。
README.md
编写技巧
大部分情况下,你可以按照编写HTML页面的方式来编写README.md
。但我们今天说点更加有趣的。
本小节将随时更新,收集一些编写小技巧。
如何插入图片
练习:
- 新建一个仓库,按一下配置构建目录:
/pic/pic1.jpg
/README.md
- 在
README.md
文件中书写一行
,提交到github,观察效果。
你也可以使用
<img src="/pic/pic1.jpg" width="100%"></img>
来添加该图片,同时还能更加精准的控制尺寸。
这样插入图片似乎还行,但我们之前提过,github是可以拿来当图床的,这样引用显然是没办法作为图床使用的。还是以/pic/pic1.jpg
图片为例,敲入以下内容:
<img src="https://github.com/<你的GithubID>/<库的名字>/raw/master/pic/pic1.jpg"></img>
也就是:
,通过这个URL就可以访问到这张图片的真正地址啦。
作为参考,你们可以到我编写的这个项目里查看此类写法。
如何居中显示
居中显示需要用到HTML标签,且内部内容也必须采用HTML标签书写,如:
<p align="center">
<img src="https://github.com/WhiteRobe/TIC2019GitTrain/raw/master/practice/example/logo.png" width="30%">
</img>
</p>
</img>
如何挂上好看的徽章
你们一定注意到了本项目的README.md
页面有一堆好看的徽章,比如:
- 输入:

可以创建:
- 输入:

可以创建:
 |
- 甚至还有图标内容——输入:
 [https://leetcode-cn.com](https://leetcode-cn.com/)
:
- 也可以使用BASE64自定义图标:
这都归功于一个项目:https://shields.io/ 欢迎各位尝试这个项目。
超链接附加悬浮标题
- 举例:
[WhiteRobe/TIC2019GitTrain](https://github.com/WhiteRobe/TIC2019GitTrain "悬浮标题")
,显示效果:
添加项目访问量监控
- 调用插件:

。
如
,显示效果:
一份好的README.md
应该包含哪些内容
- 首先,你应该在最顶上列出你的项目名称,给人一个记忆点
- 接着,给出你的LICENSE、项目参数等。(比如上文提到的那一排Badge)
- 给出项目的样例,例如一个网站项目应该给出各个界面的样子,网站的功能。
- 列出项目的依赖、环境搭建及项目运行指南。
- 如果你欢迎其他人一同完善这个项目,还要给出contributing guidelines.
- 贡献者和项目捐赠者。
这里有一份参考:carbon/README.md
强力推荐查看这个项目standard-readme,可以兼顾了解英文Readme的常见标题。
编写练习
- 仿照本仓库中的
/practice/example/README.md
编写一份README.md
文件; - 像上次一样,在你练习
pull request
时创建的文件夹中带上你的作品,然后pull request
到这个仓库。