只需一行代码,你的纯文本秒变Markdown

只要你有纯文本编辑器,加上一条语句,瞬间它就能够成为 Markdown 编辑器。
html

机器之心报道,机器之心编辑部。
浏览器

Markdeep 是一个用来写纯文本的插件,它能以 Markdown 的语法与渲染方式纯文本,并在网页上展现。同时,除了 Markdown 语法,Markdeep 还额外支持图表、数学方程等扩展能力。bash


咱们先看看效果,以下左边是纯文本编辑器的编辑页面,右边是在浏览器上的渲染效果:


Markdeep 很是容易使用,它也不须要安装插件或联网。如上所示只要在纯文本最后加上「<!—Markdeep→」那一行的表达式,它就能够变成一个地道的 Markdown 编辑器。Markdeep 不须要额外安装任何东西,也不须要导出、编译等杂七杂八的过程。

看着 Markdeep 很简单,但它的功能却很多,一点也不逊色于 Typora 等正统的 Markdown 编辑器。不论咱们是写项目的 README 文档、实验报告,仍是要作 PPT 或写论文,它都能知足。该项目提供了不少示例,例如生成的 PPT 是什么样的,后文会具体展现。

开源代码

Markdeep 是开源的,因此能够直接下载和修改源代码文件 markdeep.js。整个编辑器就是一个 JavaScript 脚本,上面定义了各类格式与渲染方式。做者表示,目前他正研究该如何有效下降脚本文件大小。

用于表格处理的部分代码,整个脚本有超过 5000 行代码。

脚本源码地址: casual-effects.com/markdeep/la…

做者表示,这个项目原本就是一个业余项目,它并不会有完整的技术支持。不过只要提交的 Bug 足够具体,做者都会完善它。此外,该项目还会常常加入一些新特性,从 2015 年 10 月份的初版,到今年 2 月份的最新版,这个编辑器已经维护了很长时间。

Markdeep 怎么用

若是你须要建立一个 Markdeep 的文件,只须要打开任意一个文本编辑器,而后开始编辑。完成文本编辑工做后,只须要在其底部写下一个简单的代码就好了。而后,将这个文档保存为纯文本文件,使用 .md.html 为扩展名。

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://casual-effects.com/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>复制代码

若是你但愿在源文档中使用 Unicode,则须要在文档顶部先加上这句话:网络

<meta charset="utf-8">复制代码

想要看看效果?你能够将文本拖入浏览器或双击它。即便网络离线也能够查阅文档。若是不想由于离线而失去格式,能够将 markdeep.min.js 文件和文档保存在一个文件夹中。

若是想要看看 Markdeep 原始文本,在文件 URL 最后加上「?noformat」便可。

上手示例

小编随手测试了几个典型 Markdown 语法,好比:代办列表、自动连接、表格、内联图片、代码。与此同时, LaTeX 的数学表达式和图形也能直接设计,而不须要任何插件。具体效果可参考:


简而言之,配备完善,对于熟悉 Markdown 的小伙伴来讲,用起来会十分顺手及方便。这意味着,在有网的状况下,随意拎一个文本编辑器后,就再也没有人能拦得了你使用 Markdown 了。与此同时,时时预览效果也很是简便,只须要在文本编辑器里修改,浏览器中刷新下即可呈现最新效果。

Markdeep 能干什么

只要是 Markdown 支持的,Markdeep 就可以支持,它在业界和学术界能获得普遍使用。以下所示,各类题材与格式的文档都能用 Markdeep 完成:
  • API 文档编辑器

  • 教学大纲工具

  • 游戏设计文件测试

  • 家庭做业网站

  • 课程 PPTspa

  • 软件库网站插件

  • 我的博客

  • 简历

  • 论文


看起来 Markdeep 彷佛什么都能作,项目做者一样也展现了这些方面的效果图:

Markdeep 制做的 PPT。

Markdeep 制做的我的简历。

总之,除了使用方便、展现炫酷,Markdeep 的功能也是很是强大。正如其它开发者所强调的,Markdeep 是能制做简单图表的 Markdown 工具,它以一种「ASCII Art」的方式用纯文本制做出图形,而且不用渲染也很是明晰。
相关文章
相关标签/搜索