写做利器——Markdown

一篇让新手看得懂,懂了就会用的Markdown教程html

什么是Markdown?

原样摘抄网络对于Markdown的介绍没有任何意义,简单说来Markdown就是经过极简的语法编写漂亮文档的一种标记语言。特色是兼容性好、学习成本低、便于传阅。git

为何要使用Markdown?

  1. 对于程序员来讲,使用word编写文档对于代码块的支持不友好,Markdown能够直接展现原滋原味的代码,便于阅读(以及复制粘贴)。
  2. 一样对于程序员来讲,使用Markdown编写的文档能直接用于github。鄙人之前傻乎乎的使用word写了大篇幅的文档,后来将代码托管到github仓库才发现要将文档格式转换真是蛋疼。
  3. Markdown经过工具能够很容易的转换为PDF、word、html等各类格式,其中转换为PDF格式是很棒的功能。试想将本身整理好的学习笔记转为PDF存档,利用闲暇时间痛快学习岂不妙哉?并且PDF格式便于传阅,当在不知道对方系统以及环境的状况下贸然传送word文档,若对方版本不支持,岂不尴尬。
  4. 免费!启动快!无需安装!只须要安装能识别Markdown的编辑器便可,比word纯净清爽不麻烦,最重要的是木有恶心的广告干扰!
  5. 鄙人平时爱整理学习笔记、bug记录、项目踩坑经验等,之前先用记事本简单记录以后再用word进行整理,后来身边大佬都推荐Markdown,发现确实易学上手快,个中滋味本身体会。
  6. 紧跟时代步伐(随波逐流),既然你们都在说好用,好歹本身试试呗(手动滑稽)

使用Markdown的正确姿式

工欲善其事必先利其器,若是操做姿式不正确,不只感觉不到工具带来的便利反而心生不爽影响效率。程序员

开发工具

一些经常使用编程IDE都能直接编写Markdown,很少啰嗦这里推荐两款好用的软件。github

  • VSCode
    左侧编写右侧显示渲染界面。无需安装多余插件,开箱即用。
  • Typora
    简单逛了下知乎、百度、谷歌后发现Typora叫好声一片,基于时间成本(实际上是懒)来考虑,就不过多尝试其余软件了,就选它了。
    Typora是编写即渲染,写下的Markdown语法直接转换为输出后的效果,且没有左右分屏更能直观看到文章效果,Typora还自带更换主题(默认主体是Github)、导出为各类格式(PDF、word、html等)、查看大纲等功能。

不过也正是由于Typora的编写即渲染,有代码洁癖+强迫症的我习惯先用VSCode进行编写,同时结合Typora看看效果,改改错别字啥的,合理利用两个工具作好本身的事情岂不妙哉。shell

图床

图床即图片服务器,要说Markdown惟一不方便的地方大概也是图片处理了,不能像word那样直接插入本地图片。因此咱们使用图床让Markdown如虎添翼。编程

图床推荐

这里推荐七牛云和Github图床,七牛云有10G免费空间,但须要有本身的备案域名。因此我选择Github图床bash

建立Github图床
1. 注册Github帐号

略...服务器

2. 建立仓库
  • 在Github首页点击New按钮 markdown

  • 按步骤填写后完成建立(这里必定要选择公共仓库,由于外部不能访问到私有仓库,会致使Markdown中图片挂掉) 网络

3. 生成一个Token用于操做GitHub仓库
  • 点击右上角头像,选择设置按钮

  • 而后点击Developer settings

  • 而后点击Personal access tokens

  • 而后点击Generate new token

  • 最后填写token描述,勾选repo

以上,成功生成Token,须要注意的是这串token以后再也不显示,因此本身保存好。

上传工具

推荐使用PicGo

下载PicGo

在Github搜索PicGo,找到“下载安装”模块,点击下载应用连接,而后选择对应的安装包

图床配置

如今就能够痛快的使用图床了,在PicGo里面上传以后复制对应连接粘贴到编辑器中便可(注意,若仓库有重复图片文件会提示上传失败,服务端出错)

经常使用语法

如下收录Markdown经常使用语法以及对应代码,由于Markdown中同一个功能能够有多种写法,好比下划线、星星符号、减号等。着实考虑很周全(麻烦)呢。小声比比...故本教程挑选了最为最温馨写法。固然这里有完整的Markdown官网中文教程

换行

句子或段落后敲两个空格或者使用回车键敲一个空行便可换行

标题

“#”个数从1-6分别表示为1-6级标题,须要注意的是#符号后面要有一个空格

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
复制代码

区块引用

在每行或者整个段落的最前面加上">"符号

> 就像这样
复制代码

区块引用能够嵌套

1 我爱你啊 很感谢很想念有你的夏天

2 没有人说谎啊 可时间会擦掉承诺的话

3 很爱你啊 以沉默以眼泪以正好时光

> 1  
> 我爱你啊 很感谢很想念有你的夏天
>> 2  
> 没有人说谎啊 可时间会擦掉承诺的话
>>> 3  
> 很爱你啊 以沉默以眼泪以正好时光
复制代码

引用的区块内也可使用其余的 Markdown 语法,包括标题、列表、代码区块等:

这是一个标题

  1. 这是第一行列表项
  2. 这是第二行列表项 给出一些例子代码: return shell_exec("echo $input | $markdown_script");

列表

  1. 无序列表

    星号表示无序列表(星号后面记得跟空格)

*. 无序列表
复制代码
  1. 有序列表

    数字接着一个英文句点表示有序列表(数字也要跟空格)

1. 有序列表
复制代码

代码块

要在 Markdown 中创建代码块很简单,只要简单地缩进 4 个空格或是 1 个制表符,但推荐使用 ``` 符号 (连续三个反引号把它包起来),由于文章缩进比较多的话代码会很乱

if(true){
  console.log("我爱你")
}else{
  console.log("你爱我")
}
复制代码

若是要标记一小段行内代码,用一个反引号(`)把它包起来

这是一个 <p id="app">我爱你</p> 例子

这是一个 `<p id="app">我爱你</p>` 例子
复制代码

分隔线

在一行中用三个连续的减号来创建一个分隔线,行内不能有其余东西


---
复制代码

连接

连接文字用 [方括号] 来标记,后面紧接着圆括号并插入网址连接。若是要加上连接的 title 文字(鼠标放在连接文字上的提示语),只需在网址后面用双引号把 title 文字包起来便可

点我有惊喜

[点我有惊喜](http://www.baidu.com "你懂得")
复制代码

网址用尖括号包起来,Markdown 就会自动把它转成连接

www.baidu.com/

<http://www.baidu.com/>
复制代码

图片跟文字连接相似,格式为: ![描述文字](图片连接)

示例图片

![示例图片](https://user-gold-cdn.xitu.io/2019/5/31/16b0ce22f5de1031?w=690&h=388&f=gif&s=71227)
复制代码

强调

一个星号表示字体倾斜,转为 标签。二个星号表示字体加粗,转为 标签。

我爱你

*我爱你*
复制代码

我爱你

**我爱你**
复制代码

总结

建议:github图床的文件夹直接命名为images,上传后的图片以日期命名,格式为(年-月-日-数字从1开始的顺序)如18-05-31-1

相关文章
相关标签/搜索