随时随地使用markdown写作

  前些天做了一个类似知乎的web应用,使用react + ant design pro,由于需要一个富文本编辑插件,寻找了好久,找到了一个相对合适的react富文本编辑插件: react-draft-wysiwyg,最后勉强实现了效果, 但是这个插件在react 16 以上的版本有部分兼容性问题, 查看github貌似这个项目也没有人继续维护了。于是就在想,是否富文本编辑器是体验最好的,于是我看到了markdown。

先说说我觉得markdown编辑的好处:

  1. 可以以一种比较简单的方式处理格式,个人觉得比较简化,可能是程序员的福音吧;
  2. 现在绝大多数的博客网站或社交网站都支持markdown转换文章;
  3. 使用markdown编辑可以在没有网络或不使用编辑后台的方式离线编辑后上传;

其次是个人发现markdown的不足:

  1. 需要一个入门的过程,不像富文本那样大家都会,毕竟word应该没人没用过;
  2. 没有富文本那样的上传文件(图片、视频)那样方便,要么引用静态文件,要么使用类似oss这样的文件服务;
  3. 排版的方面要多注意,样式什么的需要写一些符号来支持,总之需要一点门槛吧;

快速开始

编辑器推荐(排名不分先后)

1. Visual studio Code (安装preview插件: Markdown Preview Enhanced)
2. MarkdownPad
3. BookPad(window10)
4. Typora
5. Atom
7. ...其他一些编辑器都可以,但是最好可以preview,毕竟可以看见自己写的是不是自己所想的那样
8. 还有许多在线markdown编辑的网站和chrome的插件,但我觉得下一个编辑器会方便的多

3分钟入门语法

标题分级

#一级标题
##二级标题
###三级标题
####四级标题
#####五级标题
######六级标题

段落格式

首行缩进:   一个空文字   一个空字符 中文使用  
段落换行: 最好段尾最后加上2空格再回车
文本居中: 
我要居中
文本居右:

我要居右

其实就是html语法 斜体文本: *斜体文本* / _斜体文本_ 粗体文本: **粗体文本** / __粗体文本__ 粗斜文本: ***粗斜文本*** / ___粗斜文本___ 分隔线: *** / --- (三个以上就行) 删除线: ~~删除线~~ 下划线: 下划线 标注: xxx[^我是标注] 需要声明标注的解释: [^我是标注]: 我是标注的声明 超链接: [百度](http://baidu.com) 图片: ![alt text](url) 这里的url可以是网页上的图片url,也可以是自己oss中的图片链接,还可以是静态资源的引用(比如此文档统计目录下的图片 img.jpg 可以使用 ![alt](img.png) 的方式引入) 区块: > 我是区块 (每次嵌套换行多一个 > )

列表格式

无序列表: */+/- 开头
有序列表: 1. 内容 (注意. 之后的空格)
嵌套列表: 一层列表之后换行以 - 开头
          1. 内容
            - 二级 (同样要注意- 后的空格)

代码片段

推荐方式:

``` 语言(java)
public static void main(String[] args) {
 System.out.println("Hello world!");
}
```

表格

后台接口开发者一般都有过用markdown写接口文档的经历

|名称  | 类型 | 长度 | 非空 | 示例 |
|:--- |---:  |:---: |-----|------|
|left |right |center |true |text |
|参数1|String| 64   | true | xxxx |

其中的 : 存在的方向用来标识字段在table中的位置

数学公式(如果用不到可以先跳过)


1. 行内与独行
  行内公式:将公式插入到本行内,符号:$公式内容$,如:$xyz$
  独行公式:将公式插入到新的一行内,并且居中,符号:$$公式内容$$,如:$$xyz$$

2. 上标、下标与组合
  上标符号,符号:^,如:$x^4$
  下标符号,符号:_,如:$x_1$
  组合符号,符号:{},如:${16}_{8}O{2+}_{2}$

3. 汉字、字体与格式
  汉字形式,符号:mbox{},如:$V_{mbox{初始}}$
  字体控制,符号:displaystyle,如:$\displaystyle \frac{x+y}{y+z}$
  下划线符号,符号:underline,如:$\underline{x+y}$
  标签,符号\tag{数字},如:$tag{11}$
  上大括号,符号:overbrace{算式},如:$\overbrace{a+b+c+d}^{2.0}$
  下大括号,符号:underbrace{算式},如:$a+\underbrace{b+c}_{1.0}+d$
  上位符号,符号:stacrel{上位符号}{基位符号},如:$\vec{x}stackrel{mathrm{def}}{=}{x_1,\dots,x_n}$

4. 占位符
  两个quad空格,符号:\qquad,如:$x \qquad y$
  quad空格,符号:\quad,如:$x \quad y$
  大空格,符号\,如:$x \ y$
  中空格,符号\:,如:$x : y$
  小空格,符号\,,如:$x , y$
  没有空格,符号``,如:$xy$
  紧贴,符号\!,如:$x ! y$

5. 定界符与组合
  括号,符号:()\big(\big) \Big(\Big) \bigg(\bigg) \Bigg(\Bigg),如:$()\big(\big) \Big(\Big) \bigg(\bigg) \Bigg(\Bigg)$
  中括号,符号:[],如:$[x+y]$
  大括号,符号:\{ \},如:${x+y}$
  自适应括号,符号:\left \right,如:$\left(x\right)$,$\left(x{yz}\right)$
  组合公式,符号:{上位公式 \choose 下位公式},如:${n+1 \choose k}={n \choose k}+{n \choose k-1}$
  组合公式,符号:{上位公式 \atop 下位公式},如:$\sum_{k_0,k_1,\ldots>0 \atop k_0+k_1+\cdots=n}A_{k_0}A_{k_1}\cdots$

6. 四则运算
  加法运算,符号:+,如:$x+y=z$
  减法运算,符号:-,如:$x-y=z$
  加减运算,符号:\pm,如:$x \pm y=z$
  减甲运算,符号:\mp,如:$x \mp y=z$
  乘法运算,符号:\times,如:$x \times y=z$
  点乘运算,符号:\cdot,如:$x \cdot y=z$
  星乘运算,符号:\ast,如:$x \ast y=z$
  除法运算,符号:\div,如:$x \div y=z$
  斜法运算,符号:/,如:$x/y=z$
  分式表示,符号:\frac{分子}{分母},如:$\frac{x+y}{y+z}$
  分式表示,符号:{分子} \voer {分母},如:${x+y} \over {y+z}$
  绝对值表示,符号:||,如:$|x+y|$

7. 高级运算
  平均数运算,符号:\overline{算式},如:$\overline{xyz}$
  开二次方运算,符号:\sqrt,如:$\sqrt x$
  开方运算,符号:\sqrt[开方数]{被开方数},如:$\sqrt[3]{x+y}$
  对数运算,符号:\log,如:$\log(x)$
  极限运算,符号:\lim,如:$\lim^{x \to \infty}_{y \to 0}{\frac{x}{y}}$
  极限运算,符号:\displaystyle \lim,如:$\displaystyle \lim^{x \to \infty}_{y \to 0}{\frac{x}{y}}$
  求和运算,符号:\sum,如:$\sum^{x \to \infty}_{y \to 0}{\frac{x}{y}}$
  求和运算,符号:\displaystyle \sum,如:$\displaystyle \sum^{x \to \infty}_{y \to 0}{\frac{x}{y}}$
  积分运算,符号:\int,如:$\int^{\infty}_{0}{xdx}$
  积分运算,符号:\displaystyle \int,如:$\displaystyle \int^{\infty}_{0}{xdx}$
  微分运算,符号:\partial,如:$\frac{\partial x}{\partial y}$
  矩阵表示,符号:\begin{matrix} \end{matrix},如:
  $$
  \begin{bmatrix}
    1 & 2 & 3 \\
    4 & 5 & 6 \\
    7 & 8 & 9
    \end{bmatrix} \tag{1}
  $$

8. 逻辑运算
  等于运算,符号:=,如:$x+y=z$
  大于运算,符号:>,如:$x+y>z$
  小于运算,符号:<,如:$x+y

参考链接

数学公式: https://www.jianshu.com/p/e74eb43960a1
菜鸟教程: https://www.runoob.com/markdown/md-lists.html
画矩阵: https://blog.csdn.net/qq_38228254/article/details/79469727

你可能感兴趣的:(随时随地使用markdown写作)