【系统学习Markdown1】基础语法入门

我的更多相关文章:

  • 【系统学习Markdown1】基础语法入门
  • 【系统学习Markdown2】mermaid等语法插入时序图、流程图、甘特图等高级插图
  • 【系统学习Markdown3】编写插入Latex数学公式
  • Markdown 是一种轻量级且易使用的标记语言,通过对标题、正文、加粗、链接等主要文本格式的预设编码,帮用户在写作中有效避免频繁的格式调整,获得更加流畅沉浸的写作体验。

  • Markdown具有一系列衍生版本,用于扩展Markdown的功能(如表格、脚注、内嵌HTML等等),这些功能原初的Markdown尚不具备,它们能让Markdown转换成更多的格式

本文内容整合了:

  • 果冻虾仁的github
  • 印象笔记官方指南
  • 简明版有道云笔记Markdown指南
  • 印象笔记终于支持 Markdown 了,如何才能真正用好它?
  • 以及一些自己的思考总结

目录 ([TOC])

[TOC] (emmmm……貌似不支持)


目录效果

标题(#### 一、标题)

下划线下划线

删除线(~删除线~)

***、---、___ 分隔线

斜体(*斜体*)

直接回车不能换行,
可以在上一行文本后面补两个空格,
这样下一行的文本就换行了。  

或者就是在两行文本直接加一个空行。

也能实现换行效果,不过这个行间距有点大。  

图片(**加粗**)

格式:![alt](URL title)

alt和title即对应HTML中的alt和title属性(都可省略):

  • alt表示图片显示失败时的替换文本
  • title表示鼠标悬停在图片时的显示文本(注意这里要加引号)

URL即图片的url地址,如果引用本仓库中的图片,直接使用相对路径就可了,如果引用其他github仓库中的图片要注意格式,即:仓库地址/raw/分支名/图片路径,如:

https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
图片

注意例2的写法使用了URL标识符的形式,在链接一节有介绍。

在文末有foryou的定义:
[foryou]:https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
[foryou]:https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif

另外,针对插入的本地图片可以控制图片大小,在拖拽、拷贝或者点击插入本地图片之后,直接在图片名称后面(无需空格)添加以下语法均可以按照以下要求控制图片大小:(只有印象笔记才能实现)

@w=300
@h=150
@w=200h=100
@h=100w=200
image

@w=300

链接

  • 语法1:[印象笔记官网](https://www.yinxiang.com/) 印象笔记官网
  • 语法2:[我的知乎][zhihu] [我的知乎][zhihu] # 在中不能实现

语法2由两部分组成:

  • 第一部分使用两个中括号,[ ]里的标识符(本例中zhihu),可以是数字,字母等的组合,标识符上下对应就行了(姑且称之为URL标识符)
  • 第二部分标记实际URL。

使用URL标识符能达到复用的目的,一般把全文所有的URL标识符统一放在文章末尾,这样看起来比较干净。

[zhihu]:https://github.com/guodongxiaren/README#%E6%A8%AA%E7%BA%BF
[zhihu]:https://github.com/guodongxiaren/README#%E6%A8%AA%E7%BA%BF
URL语法:[标签名](链接地址)

图片链接 (重点难点)

给图片加链接的本质是混合图片显示语法和普通的链接语法。普通的链接中[ ]内部是链接要显示的文本,而图片链接[ ]里面则是要显示的图片。直接混合两种语法当然可以,但是十分啰嗦,为此我们可以使用URL标识符的形式。


例子

因为图片本身和链接本身都支持URL标识符的形式,所以图片链接也可以很简洁(见例3)。
注意,此时鼠标悬停时显示的文字是图片的title,而非链接本身的title了。

锚点

其实呢,每一个标题都是一个锚点,和HTML的锚点(#)类似,比如我们:
[ 回到标题 ](#标题) 回到标题 (不知道为什么实现不了)
不过要注意,标题中的英文字母都被转化为小写字母了。
以前GitHub对中文支持的不好,所以中文标题不能正确识别为锚点,但是现在已经没问题啦!

表格

| 帐户类型 | 免费帐户 | 标准帐户 | 高级帐户 |
| --- | --- | --- | --- |
| 帐户流量 | 60M | 1GB | 10GB |
| 设备数目 | 2台 | 无限制 | 无限制 |
| 当前价格 | 免费 | ¥8.17/月 | ¥12.33/月|
帐户类型 免费帐户 标准帐户 高级帐户
帐户流量 60M 1GB 10GB
设备数目 2台 无限制 无限制
当前价格 免费 ¥8.17/月 ¥12.33/月
对齐

貌似现在印象笔记不能实现,但有道云笔记可以实现

表格文本对齐

混合其他语法
  • 使用普通文本的删除线,斜体等效果
  • 表格中嵌入图片(链接)

表情

目前印象笔记貌似不支持
Github的Markdown语法支持添加emoji表情,输入不同的符号码(两个冒号包围的字符)可以显示出不同的表情。比如:blush:,可以显示。

具体每一个表情的符号码,可以查询GitHub的官方网页http://www.emoji-cheat-sheet.com。
可以直接在此查看emoji

列表

多级无序列表
  • aaa
    • bbb
  • ccc
    • ddd
      • eee
- aaa    
    - bbb
* ccc
    * ddd
        * eee
多级有序列表

面向对象的三个基本特征:

  1. 封装
    1.1 ……
    1.1.1 ……
  2. 继承
  3. 多态
面向对象的三个基本特征:

1. 封装
    1.1 ……
        1.1.1 ……
2. 继承
3. 多态

(PS:这个跟Githup有些区别)

复选框列表

复选框列表
- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
* [x] 编码
* [ ] 测试
* [ ] 交付

您可以使用这个功能来标注某个项目各项任务的完成情况

Tip:

在GitHub的issue中使用该语法是可以实时点击复选框来勾选或解除勾选的,而无需修改issue原文。

文字高亮

tag (`tag`)

语句块

语法1 (文本第一行需要空行)

语句块1      #在一行开头加入1个Tab或者4个空格。
欢迎到访
很高兴见到您
祝您,早上好,中午好,下午好,晚安 

语法2

语句块2     #使用一对各三个的反引号:

多级块引用

数据结构

二叉树

平衡二叉树

满二叉树

> 数据结构
>> 树
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树

代码高亮

在三个反引号后面加上编程语言的名字,另起一行开始写代码,最后一行再加上三个反引号。

```python
……
```

#!/usr/bin/python
import re



line = "Cats are smarter than dogs"



matchObj = re.match( r'(.*) are (.*?) .*', line, re.M|re.I)



if matchObj:
    print "matchObj.group() : ", matchObj.group()
    print "matchObj.group(1) : ", matchObj.group(1)
    print "matchObj.group(2) : ", matchObj.group(2)
else:
    print "No match!!"

diff语法

版本控制的系统中都少不了diff的功能,即展示一个文件内容的增加与删除。 GFM中可以显示的展示diff效果。使用绿色表示新增,红色表示删除。

其语法与代码高亮类似,只是在三个反引号后面写diff, 并且其内容中,以 + 开头表示新增,- 开头表示删除。

亲测:目前印象笔记并不支持,有道云笔记和支持,渲染效果有些不同。

有道云笔记的正常效果

diff语法渲染的效果:

+ aaa
- bbb

文本缩进:

  

不建议使用Markdown的几种情况

  1. 项目属性的笔记:所谓项目属性,就是创建笔记的目的是为了完成某个工作和生活的专项任务

    • 完成新作品的灵感记录、 活动策划等
    • 因为项目笔记往往会涉及到非常多附件、图片、排期、任务列表等内容
  2. 对文本格式有更多需求的笔记

    • 可能会需要各种不同格式去区分不同的内容,比如不同颜色代表概念、重点、难点、背诵点等,普通笔记的体验会更出色。
  3. 印象笔记中其他几点临时不支持的内容

    • 移动端和网页端不支持对 Markdown 笔记的编辑
    • 暂止不支持笔记内部链接,不支持添加印象笔记内链

看完本文后的进阶路径

  • 如果你想在Markdown中插入图表,请看Markdown插入图表(主要介绍mermaid语法)
  • 如果你想在Markdown中插入数学符号和公式,请看小白入门LaTex编写数学公式

你可能感兴趣的:(【系统学习Markdown1】基础语法入门)