小型即时Markdown预览服务器——instant-markdown-d使用教程

1. 项目介绍

instant-markdown-d 是一个基于Node.js的小型服务器，它能够实现Markdown文件的即时编译和预览。用户可以轻松地为任何文本编辑器编写插件来与它对接。目前已有一个针对Vim的插件：vim-instant-markdown。

2. 项目快速启动

首先，您需要在您的系统上安装Node.js。接下来，通过以下命令之一安装instant-markdown-d：

[sudo] npm -g install instant-markdown-d

或者，如果您使用yarn，可以使用以下命令（但不推荐，请参考issue #86）：

[sudo] yarn global add instant-markdown-d

安装完成后，运行以下命令启动服务器：

instant-markdown-d

默认情况下，服务器将在本地监听8090端口。

3. 应用案例和最佳实践

3.1 使用环境变量

• 若要允许服务器在您的网络中对外可见，请设置环境变量 INSTANT_MARKDOWN_OPEN_TO_THE_WORLD=1。注意：仅在可信网络中使用此设置！
• 若要允许执行脚本，请设置 INSTANT_MARKDOWN_ALLOW_UNSAFE_CONTENT=1。
• 若要阻止加载外部资源（如图片、样式表、框架和插件），请设置 INSTANT_MARKDOWN_BLOCK_EXTERNAL=1。
• 若要指定Mathjax字体文件的本地路径，请设置 INSTANT_MARKDOWN_MATHJAX_FONTS。

3.2 REST API使用

• 刷新Markdown页面：向 http://localhost:<port> 发送PUT请求，并包含新的Markdown文件内容。
• 关闭网页：向 http://localhost:<port> 发送DELETE请求。

4. 典型生态项目

instant-markdown-d 的生态系统中，以下是一些值得关注的典型项目：

• vim-instant-markdown：Vim/Neovim的插件，实现Markdown实时预览。
• 其他文本编辑器的类似插件：社区中可能存在为其他文本编辑器编写的插件，以实现类似的功能。

以上就是instant-markdown-d的简要教程，希望对您有所帮助！