【玩转写作平台】Markdown & 快捷键详解

发布于: 2020 年 05 月 20 日
【玩转写作平台】Markdown & 快捷键详解

欢迎各位创作者们加入写作平台~

写作平台上线以来,陆陆续续收到了创作者们很多高质量的使用反馈,还有针对产品优化提出的一系列建议。在解答疑问的过程中,发现很多技术创作者们对写作平台是否支持 Markdown 的问题存在疑惑,不知道如何触发 Markdown 语法,我们特此为大家准备了详解指南来解决大家的疑问。

关于 Markdown

Markdown 语法,一般可分为原生语法和衍生语法。

 

原生语法主要由以下两部分构成:

  • 区块元素:标题、引用、列表(分为有序和无序)、区块代码、分隔线等

  • 行内元素:强调(包含加粗和斜体)、行内代码、链接、图片等

是由 John Gruber 2004 年创造,此后貌似再也没有更新过,但足以满足大部分写作。

 

为了补充原生语法所不具备的功能,一些组织或者个人对其进行了扩展,即所谓的衍生语法,主要有:

 

以上原生和各种衍生语法的具体说明和使用方式,可以点击上面相应的链接查看,除此之外,我们使用过的各种本地以及在线编辑器可能还创造了属于自己的语法,皆归为其它,不做过多介绍。


写作平台 Markdown 使用方法

我们的编辑器暂时没有支持衍生语法,不过可以使用菜单栏按钮来实现,比如删除线,公式、图片、视频等等。

但我们目前已经支持了绝大部分原生语法,只不过均需要空格键(Space)来触发,比如一级标题可以使用1个#字符,然后加上1个空格,正确触发后会是所见即所得的样子,下面将一一列出。

标题

 

原生语法有 Setext 和 Atx 两种形式,我们仅支持最常见的 Atx 形式,最多支持到五级:

 

# + Space

## + Space

### + Space

#### + Space

##### + Space

斜体

 

原生语法的两种形式我们均有支持,即:

 

*xxx* + Space

或者

_xxx_ + Space

粗体

 

原生语法的两种形式我们均有支持,即:

 

**xxx** + Space

或者

__xxx__ + Space

分割线

 

原生语法的三种形式我们均有支持,即:

 

*** + Space

或者

___ + Space

或者

--- + Space

有序列表

 

Number. + Space

 

支持多级缩进,最多八级,如下:

  1. xxxxxx

  2. xxxxxx

  3. xxxxxx

  4. xxxxxx

  5. xxxxxx

  6. xxxxxx

  7. xxxxxx

 

Tips:Number 不需要从 1 开始,而且数字不需要连续。

无序列表

 

原生语法的三种形式我们均有支持,即:

 

* + Space

或者

+ + Space

或者

- + Space

 

同样支持多级缩进,最多八级,如下:

 

  • xxxxxx

  • xxxxxx

  • xxxxxx

  • xxxxxx

  • xxxxxx

  • xxxxxx

  • xxxxxx

  • xxxxxx

  • xxxxxx

  • xxxxxx

行内代码

 

`inline code` + Space

Tips:如果使用菜单按钮添加行内代码,需要先选中文本。

块级代码

 

这可能是唯一与原生语法不太一样的地方,您可以使用 3 个反引号加 1 个空格来触发,即:

 

``` + Space

引用

 

> + Space

 

引用中支持强调、行内代码、行内公式等

 

轻强调,即斜体,重强调,即加粗,还可以使用下划线或者删除线,当然,也可以一起使用

inline code

C=2πr

 

不支持标题、列表、区块代码等,且不支持嵌套引用。

超链接

 

原生语法有 inline 和 reference 两种形式,我们暂时仅支持 inline 式,即:

 

[title](url) + Space

 

另外原生语法还支持自动链接(一对尖括号扩起来),我们也是支持的,只需要原样输入链接,发布后即可自动识别。

 


关于自动识别转换和图片上传

以上即为我们的编辑器目前支持的所有 Markdown 语法,其它语法以及功能仍在不断完善中,敬请期待。

另外,从其它编辑器复制已编辑好的 Markdown 内容到写作平台编辑器内粘贴,是支持自动识别转换的,前提是不能带有样式,如果自动转换失败大概率是复制时带了样式造成,此时可以尝试使用无格式粘贴,具体快捷键可参考以下部分。

关于图片,虽然我们暂时还不支持它的语法,但粘贴图片的语法(![alt](url))到编辑器是会自动识别转换的。另外,我们还支持多种图片上传的方式:

  • 点击菜单-图片按钮上传

  • 复制网络图片粘贴到编辑器内上传

  • 截图后复制粘贴到编辑器内上传

  • 直接将本地图片拖拽到编辑器内上传

您可以挑选适合你的方式上传图片,还可以同时上传多张喔~

常用快捷键

除了使用 Markdown 语法,在创作中您还可以使用菜单栏按钮以及其所对应的快捷键,具体快捷键在 Hover 菜单按钮时有给出提示。

下面是一些支持但没有给出提示的常用快捷键,相信您早已烂熟于心。

以 Mac 系统为例(Windows 系统把以下 Command 键换成 Ctrl 键即可):

  • 手动保存草稿:Command + S

  • 增加缩进:Tab

  • 减少缩进:Shift + Tab

  • 撤销:Command + Z

  • 重做:Command + Shift + Z 或者 Command + Y

  • 复制:Command + C

  • 粘贴:Command + V

  • 无格式粘贴(Chrome):Command + Shift + V

  • 无格式粘贴(Safari):Command + Shift + Opt + V


大家对于写作平台还有什么疑问&建议都可以在评论区留言讨论~本帖长期有效。也可以添加小助手微信咨询(微信号:infoqwriter)。

最后,祝愿各位创作者们在写作平台上拥有最友好的写作体验和阅读体验,这个UGC社区,你值得拥有!

作者 | 姜冲

发布于: 2020 年 05 月 20 日 阅读数: 318
用户头像

InfoQ写作平台

关注

写作平台小助手 2020.04.28 加入

咨询微信:infoqwriter

评论 (6 条评论)

发布
用户头像
为什么不直接给出2个选项?一个是现在的 HTML的,一个是 MarkDown 的
2020 年 05 月 25 日 09:26
回复
用户头像
有心
2020 年 05 月 20 日 20:56
回复
感谢支持!
2020 年 05 月 21 日 10:08
回复
用户头像
学会了😁😁😁
2020 年 05 月 20 日 19:47
回复
学会就好
2020 年 05 月 21 日 10:09
回复
用户头像
学会了😎😎😎😎
2020 年 05 月 20 日 19:47
回复
用户头像
InfoQ编辑器 脚注是如何添加的? 我按照常规方法试了一下并没有识别出来. 测试方式如下:

That's some text with a footnote.[^1]


[^1]: And that's the footnote.
2020 年 05 月 20 日 19:45
回复
脚注属于衍生语法,文章里说了,写作平台编辑器暂时只支持大部分原生语法。
2020 年 05 月 21 日 14:45
回复
用户头像
炒鸡实用的教程
2020 年 05 月 20 日 16:38
回复
哈哈哈,被你发现了
2020 年 05 月 20 日 17:34
回复
没有更多了
【玩转写作平台】Markdown & 快捷键详解