平时偶尔会用Markdown写点东西,但因为不经常用,所以在实际写时,总会忘这忘那,每次都要到网上去查。
所以,今天我决定好好学下Markdown,然后整理出来一篇完整的文章,以便备忘。
但我在写这篇文章的时候,发现只介绍语法却没有实际效果话,最终结果并不是非常直观,所以我决定放弃这篇文章,而是在GitHub上新开一个项目,用Markdown形式来写一份完整的Markdown教程。
这个项目叫做 markdown-by-example,地址为:
https://github.com/wangyuntao/markdown-by-example
该项目中,我打算用一个个小例子来介绍Markdown的各个方面,尽量保证排版整洁,语法精确。
其实网上也有很多类似的文章或项目,我之所以没有用是因为,他们这些文章或项目要么排版不好,要么没有实际效果展示,要么没有相关语法的细节描述。
所以,我决定自己整理一份。
该项目中所有例子的语法及各种注意事项,都是我通过仔细阅读Markdown的CommonMark标准得来的,所以我认为还是有一定的质量保证的。
这个项目今天才开始写,所以现在还没有几篇文章,不过后续都会加上,最终会成为一个完整的Markdown教学文档。
随便看下今天我写的其中一篇:
如果对该项目感兴趣,帮忙点个star,谢谢。
完。
本文分享自 Linux内核及JVM底层相关技术研究 微信公众号,前往查看
如有侵权,请联系 cloudcommunity@tencent.com 删除。
本文参与 腾讯云自媒体同步曝光计划 ,欢迎热爱写作的你一起参与!