资讯专栏INFORMATION COLUMN

工具集核心教程 | 第一篇: .md即markdown文件的基本常用编写语法(图文并茂)

lucas / 1741人阅读

摘要:欢迎关注我的微信公众号获取更多更全的学习资源,视频资料,技术干货公众号回复学习,拉你进程序员技术讨论群,干货资源第一时间分享。公众号回复全栈,领取前端,,产品经理,微信小程序,等资源合集大放送。公众号回复面试,领取面试实战学习资源。

序言:

感觉只要是不写博客,人就很变得很懒,学的知识点感觉还是记不住,渐渐地让我明白,看的越多,懂的越少(你这话不是有毛病吗?应该是看的越多,懂的越多才对),此话怎讲,当你在茫茫的知识库里面东看看,西看看的时候,很快就被海量的知识给淹没了,根本就不知道哪些是对的,哪些是错的,感觉好像这个也懂了,那个也懂了,但是真正写起来,脑子又一片空白,又好像什么都不懂,这种状态时有发生,这就叫不懂装懂,最根本的原因就是看的太多,写的太少,所以为了改掉这样毛病,把被动学习变成主动学习,接下来的日子,多写写,即使是写一些学习工作中遇到的坑也是好的,没事翻出来看看,还可以加深印象,好了,废话到处!

起因:

因为现在前后端、测试交互很频繁,一个完整的项目或者教程,说明性文件必不可少!那就难免要写一些readme等等的说明性文件,但是这样的文件一般都是.md的文件,编写的语法自然跟其他格式的文件有所区别,置于为什么要用这种格式的文件,不要问我,我也不知道,大家都这么用,跟着用就对了,如果有大神知道的,不妨告知小弟,本文也是我学习写markdown文件的一个笔记吧,仅供参考!

正文: 1.标题的几种写法:

第一种:

前面带#号,后面带文字,分别表示h1-h6,上图可以看出,只到h6,而且h1下面会有一条横线,注意,#号后面有空格

第二种:

这种方式好像只能表示一级和二级标题,而且=-的数量没有限制,只要大于一个就行

第三种:

这里的标题支持h1-h6,为了减少篇幅,我就偷个懒,只写前面二个,这个比较好理解,相当于标签闭合,注意,标题与#号要有空格

那既然3种都可以使用,可不可以混合使用呢?我试了一下,是可以的,但是为了让页面标签的统一性,不建议混合使用,推荐使用第一种,比较简洁,全面

为了搞清楚原理,我特意在网上搜一下在线编写markdown的工具,发现实际上是把这些标签最后转化为html标签,如图:

在线地址请看这里: markdown在线编辑 (只是想看看背后的转换原理,没有广告之嫌)

2.列表

我们都知道,列表分为有序列表和无序列表,下面直接展示2种列表的写法:

可以看到,无序列表可以用* + 来创建,用在线编辑器看,实际上是转换成了ul>li ,所以使用哪个都可以,推荐使用*

有序列表就相对简单一点,只有这一种方式,注意,数字后面的点只能是英文的点,特别注意,有序列表的序号是根据第一行列表的数字顺序来的,比如说:

第一组本来是3 2 1 倒序,但是现实3 4 5 ,后面一组 序号是乱的, 但是还是显示 3 4 5 ,这点必须注意了

3.区块引用

比如说,你想对某个部分做的内容做一些说明或者引用某某的话等,可以用这个语句

无序列表下方的便是引用,可以有多种用途,看你的需求了,用法就是在语句前面加一个 > ,注意是英文的那个右尖括号,注意空格

引用因为是一个区块,理论上是应该什么内容都可以放,比如说:标题,列表,引用等等,看看下图:

将上面的代码稍微改一下,全部加上引用标签,就变成了一个大的引用,还有引用里面还有引用,那引用嵌套引用还没有别的写法呢?

上图可以看出,想要在上一次引用中嵌套一层引用,只需多加一个>,理论上可以无限嵌套,我就不整那么多了,注意:多层嵌套的>是不需要连续在一起的,只要在一行就可以了,中间允许有空格,但是为了好看,还是把排版搞好吧

4.华丽的分割线

分割线可以由* - _(星号,减号,底线)这3个符号的至少3个符号表示,注意至少要3个,且不需要连续,有空格也可以

应该看得懂吧,但是为了代码的排版好看,你们自己定规则吧,前面有用到星号,建议用减号

5.链接

支持2种链接方式:行内式和参数式,不管是哪一种,链接文字都是用 [方括号] 来标记。

上图可知,行内式的链接格式是:链接的文字放在[]中,链接地址放在随后的()中,举一反三,经常出现的列表链接就应该这样写:

链接还可以带title属性,好像也只能带title,带不了其他属性,注意,是链接地址后面空一格,然后用引号引起来

这是行内式的写法,参数式的怎么写:

这就好理解了,就是把链接当成参数,适合多出使用相同链接的场景,注意参数的对应关系,参数定义时,这3种写法都可以:

还支持这种写法,如果你不想混淆的话:

其实还有一种隐式链接的写法,但是我觉得那种写法不直观,所以就不写了,经常用的一般就上面2种,如果你想了解隐式链接,可以看我文章最后放出的参考地址

6.图片

图片也有2种方式:行内式和参数式,

用法跟链接的基本一样,唯一的不同就是,图片前面要写一个!(这是必须的),没什么好说的

7.代码框

这个就比较重要了,很多时候都需要展示出一些代码

如果代码量比较少,只有单行的话,可以用单反引号包起来,如下:

要是多行这个就不行了,多行可以用这个,也就是一对`

多行用三个反引号,如果要写注释,可以在反引号后面写

8.表格

这个写的有点麻烦,注意看

从这3种不同写法看,表格的格式不一定要对的非常起,但是为了好看,对齐肯定是最好的,第一种的分割线后面的冒号表示对齐方式,写在左边表示左对齐,右边为右对齐,两边都写表示居中,还是有点意思的,不过现实出来的结果是,表格外面并没有线框包起来,不知道别人的怎么弄的

9.强调

一个星号或者是一个下划线包起来,会转换为倾斜,如果是2个,会转换为加粗

10.转义

就不一一列举了,基本上跟js转义是一样的

11.删除线

常用的基本上就这些了,如果还有一些常用的,可以跟我留言,我补充上去,我觉得图文并茂才是高效学习的正确姿势,但愿为你的学习带来帮助!

最后推荐一款Window下markdown编辑器

typora非常好用的一款本地MD文件编辑器 ,中文版下载地址:typora下载
界面如下:

参考文献:

http://www.appinn.com/markdown/

http://sspai.com/25137

写在最后

欢迎关注喜欢、和点赞后续将推出更多的工具集教程,敬请期待。
欢迎关注我的微信公众号获取更多更全的学习资源,视频资料,技术干货!

公众号回复“学习”,拉你进程序员技术讨论群干货资源第一时间分享。

公众号回复“视频”,领取800GJava视频学习资源。

公众号回复“全栈”,领取1T前端Java产品经理微信小程序Python等资源合集大放送。





公众号回复“慕课”,领取1T慕课实战学习资源。








公众号回复“实战”,领取750G项目实战学习资源。

公众号回复“面试”,领取8G面试实战学习资源。



文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/77594.html

相关文章

  • 在 Ubuntu 14.04 服务器上部署 Hexo 博客

    摘要:本文将介绍如何在一台的云服务器上快速部署博客站点,如何快速发布一篇博文并通过云服务器上的私有仓库部署到服务器目录下。此外,还要在云服务器上安装和两个必备的软件包。在服务器上部署博客以下为文章正文。 推荐理由:Hexo 是用 Node.js 开发的一个静态站点生成器(Static Site Generator),支持 Markdown 语法写作,有着强大的插件系统,而且性能优异。下面我推...

    cyqian 评论0 收藏0
  • 《HelloGitHub》第 66 期

    摘要:功能齐全支持考勤会议管理云盘等,适用于企业协同办公支付工具库,轻松完成支付模块开发。包含训练好的模型和微服务,启动后可直接通过接口调用基于图像识别的自动化框架,支持吃鸡类射击类类等游戏类型。 .markdown-body{word-break:break-word;line-height:1.75;font-weight:400;font-size:15px;overflow-x:hidd...

    番茄西红柿 评论0 收藏2637
  • 个人分享--web前端学习资源分享

    摘要:前言月份开始出没社区,现在差不多月了,按照工作的说法,就是差不多过了三个月的试用期,准备转正了一般来说,差不多到了转正的时候,会进行总结或者分享会议那么今天我就把看过的一些学习资源主要是博客,博文推荐分享给大家。 1.前言 6月份开始出没社区,现在差不多9月了,按照工作的说法,就是差不多过了三个月的试用期,准备转正了!一般来说,差不多到了转正的时候,会进行总结或者分享会议!那么今天我就...

    sherlock221 评论0 收藏0

发表评论

0条评论

lucas

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<