厉害了我滴哥,用Xcode写Markdown文档

4,012 阅读2分钟

小知识,大挑战!本文正在参与“程序员必备小知识”创作活动。

本文同时参与「掘力星计划」,赢取创作大礼包,挑战创作激励金。

前言

这一篇XDM都用什么Markdown写作工具?我介绍了一些编写Markdown的工具,其中Xcode赫然在列,很多iOS开发者可能会好奇,这货能行么,这货可以好好写Markdown文档吗?

我的结论是:能,而且很强!

今天我们就来实操一把。

设置快捷键,方便预览

在正式开始用Xcode编写Markdown之前,我们最好自定义下快捷键,在Markdown的源码和预览页面进行切换,否则,写了也看不出效果也是白搭。

在Xcode的配置设置页面,key bindings搜索markup,设置键位切换playground和源码注释渲染效果,这里我自定义的快捷键是ctrl+M:

image.png

新建playground

我们新建一个playground:

image.png

选择Blank就行:

image.png

image.png

image.png

好吧,让我们开始吧。

Xcode中编写Markdown的注意事项

  • 如果要写的Markdown只有一行,需要在写之前用//:进行修饰:

源码:

image.png

ctrl+M切换到预览后:

image.png

怎么样,有内味了吧。

  • 如果要写的Markdown是多行,需要用/*: */进行整体包裹,光这么说可能看不出来什么,直接上图:

源码:

image.png

预览:

image.png

行走的代码块

也就是说在//:之后和/*: */范围内,按照Markdown的语法编写,就可以生成对应的Markdown语法效果。

可能你会问,还要加这么一个标签,才能写Markdown,我直接用一个专门写Markdown的工具不就好了,为何要特地用Xcode的playground来写?

你们忽略了playground一个重要特点,playground的既见既所得特性,我举例说明一下playground写文档的威力吧,上图:

屏幕录制2021-09-30 11.35.58.2021-09-30 11_39_22.gif

文档里面,代码还能运行,逼格满满。

2a5653dcfc75e975b9bc82798ac98ab2.gif

既见既所得,别的.md文件可以做到吗,可以做到吗,可以做到吗?

这个.playground的说明文档丢出去,再说代码看不懂,那就真的是不好意思了。

当然这个.playground文档仅限Apple系开发交流。

总结

本文介绍在Xcode中通过playground文件编写Markdown,它虽然有那么点奇奇怪怪,但是作为可以行走的代码块,目前仅此一家。

在GitHub中,我已经看见很多iOS项目都在通过playground进行文档编写了。

其实Xcode的playground还有很多好玩的功能。

大伙们在Xcode的playground玩出了什么新高度,一起分享一下呗。

我们下期见。