写点什么

【玩转写作平台】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 日阅读数: 2814
用户头像

写作平台小助手 2020.04.28 加入

欢迎添加写作平台小助手微信,拉您进交流群~ 咨询微信:infoqwriter

评论 (36 条评论)

发布
用户头像
BUG 反馈:编辑好的 markdown 文件,编辑器对行内代码的解析出现错误。如
`batch_input_shape` 会将 _input_ 解析为斜体。该 bug 非必现,有时可以正常解析。
2020 年 09 月 25 日 17:28
回复
用户头像
你好,编辑好的 markdown 文件的二级有序/无序列表无法识别并正确格式化,另外在列表下的代码块也无法正确识别。目前发现只有顶级代码块(```没有缩进)才能识别。
2020 年 09 月 24 日 16:22
回复
用户头像
谢谢分享,又复习了一遍。
2020 年 08 月 15 日 10:29
回复
用户头像
可以支持直接导入已有 markdown 么?
2020 年 07 月 13 日 06:10
回复
无格式粘贴
2020 年 07 月 13 日 14:08
回复
用户头像
基本通用的MD语法还是支持的不错的
2020 年 06 月 24 日 22:54
回复
用户头像

表格和任务列表是刚需
2020 年 06 月 16 日 20:40
回复
以后会陆续支持
2020 年 06 月 25 日 13:25
回复
用户头像
尽快支持表格吧
2020 年 06 月 09 日 15:13
回复
用户头像
请问:草稿ID:6152,点发布无响应,用浏览器开发者工具看在vendorxxxxx.js的第一行出现报错:“TypeError: Cannot read property 'charCodeAt' of undefined”。请问应如何解决?可以生成预览
2020 年 06 月 09 日 09:13
回复
这个问题已经修复过了,是因为没有填写摘要导致,您可以再试试
2020 年 06 月 10 日 12:14
回复
用户头像
啥时候可以支持表格啊
2020 年 06 月 06 日 15:59
回复
用户头像
之前在其他的编辑器里面已经写好的,直接Copy过来,没有触发,还需要手动的将原来的Space 删除再加上才行!
2020 年 06 月 06 日 11:13
回复
用户头像
哇,学到了!!!
2020 年 06 月 04 日 13:23
回复
用户头像
当在写作的那一出现有颜文字时(颜文字在光标的左边),此时删除颜文字会将整行删除掉。期望是只删除颜文字
2020 年 06 月 03 日 18:07
回复
没有复现呢亲
2020 年 06 月 03 日 19:35
回复
好的,我录制了两个小视频并附上我的环境,发给feedback@geekbang.com了。谢谢~
2020 年 06 月 04 日 08:14
回复
回复这个comment时,才发现,comment的顺序也不对呢,我是回复你的消息,却在你的消息上面。
2020 年 06 月 04 日 08:15
回复
查看更多回复
用户头像
期望在选择文字时,能支持已当前光标为起点的整行选择。
比如在macOS中,以当前位置为起点的整行的选择可以通过shift + command + 左右箭头来选择。目前在InfoQ写作平台使用上面的快捷键时,是选取从当前位置到整篇文档。谢谢~
2020 年 06 月 03 日 10:31
回复
更正一下,上述行为只发生在列表和代码段中,普通正文表现是正常的。
2020 年 06 月 03 日 13:42
回复
这个也没有复现呢亲
2020 年 06 月 03 日 19:35
回复
用户头像
为什么不直接给出2个选项?一个是现在的 HTML的,一个是 MarkDown 的
2020 年 05 月 25 日 09:26
回复
不希望打断用户的写作体验,这样更好,你试试就知道了
2020 年 05 月 30 日 21:28
回复
吐槽一下,平台支持的不太好,写好的markdown,复制过来,要调整很多。难受
另外,还不支持表格。
2020 年 06 月 01 日 16:10
回复
用户头像
有心
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 & 快捷键详解