教你写 Markdown

平时偶尔会用Markdown写点东西,但因为不经常用,所以在实际写时,总会忘这忘那,每次都要到网上去查。

所以,今天我决定好好学下Markdown,然后整理出来一篇完整的文章,以便备忘。

但我在写这篇文章的时候,发现只介绍语法却没有实际效果话,最终结果并不是非常直观,所以我决定放弃这篇文章,而是在GitHub上新开一个项目,用Markdown形式来写一份完整的Markdown教程。

这个项目叫做 markdown-by-example,地址为:

https://github.com/wangyuntao/markdown-by-example

该项目中,我打算用一个个小例子来介绍Markdown的各个方面,尽量保证排版整洁,语法精确。

其实网上也有很多类似的文章或项目,我之所以没有用是因为,他们这些文章或项目要么排版不好,要么没有实际效果展示,要么没有相关语法的细节描述。

所以,我决定自己整理一份。

该项目中所有例子的语法及各种注意事项,都是我通过仔细阅读Markdown的CommonMark标准得来的,所以我认为还是有一定的质量保证的。

这个项目今天才开始写,所以现在还没有几篇文章,不过后续都会加上,最终会成为一个完整的Markdown教学文档。

随便看下今天我写的其中一篇:

如果对该项目感兴趣,帮忙点个star,谢谢。

完。

本文分享自微信公众号 - Linux内核及JVM底层相关技术研究(ytcode),作者:wangyuntao

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-10-19

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Git示例教程 - 删除本地分支及远程分支

    为了方便测试,我们先在GitHub上创建一个名为git-test-repo的仓库,然后将其克隆到本地,并看下其当前的分支情况:

    wangyuntao
  • Git示例教程 - 创建本地分支及远程分支

    为了方便测试,我们先在GitHub上创建一个名为git-test-repo的仓库,然后将其克隆到本地,并看下其当前的分支情况:

    wangyuntao
  • 编译一个默认输出hello world的linux内核

    本文主要讲述,如何编译一个linux内核,使其默认执行我们提供的一个hello world程序。

    wangyuntao
  • Markdown 你真的懂了吗

    为什么说,每个人都应该学会 Markdown 在 IT 圈和作家圈,Markdown 是一种非常风靡的语言,可能大家都已经或多或少的接触过,或者正在使用了,如果...

    小之丶
  • 我的Markdown的利器——Markdown Here、有道云笔记、iPic

    网上有很多人推荐的Markdown的工具包括专业的Markdown工具,如Mou,macdown等,也有人用编辑器装上插件后就使用,sublime、atom、v...

    itmifen
  • 我的Markdown的利器——Markdown Here、有道云笔记、iPic

    Markdown逐渐成为大家文章编辑的首选,这里推荐两个比较冷门的Markdown工具。 用什么当做Markdown的主力工具? 网上有很多人推荐的Markdo...

    itmifen
  • 八款不可错过的热门 Markdown 开发包 | 码云周刊第 34 期

    八款不可错过的热门 Markdown 开发包 1码云项目推荐 项目名称:Markdown 编辑器 Editor.md ? 项目简介:Editor.md 是一个可...

    码云Gitee
  • 有道云笔记 - Markdown模板(文首附markdown源码,即.md文件)

    附 本文的Markdown源码镜像: https://github.com/yanglr/AlgoSolutions/blob/master/Youdao...

    Enjoy233
  • 简书markdown教程

    ##1 支持 Markdown 的编辑器 ###Windows 推荐 Sublime Text 3,强大优雅的编辑器。 MarkdownPad,一款可以直...

    周小董
  • 【4】写博客神器——Markdown(附工具推荐)

    注意:这里的!、[、]、(、)均为英文输入法,且简书平台Markdown编辑器只要将图片文件拖入输入区域,即可生成Markdown文本,读者们只要修改描述图片的...

    代码咖啡

扫码关注云+社区

领取腾讯云代金券