在前端开发中,输出文档是一个必不可少的环节。虽然可以直接使用 Word 文档或者其他编辑器来编写和输出文档,但是如果能够在发行版本中包含文档,就能够更方便地让读者阅读。
这时就需要一个类似 Markdown 的标记语言,并能够将其转换为 HTML 或者 PDF 等格式,从而方便地输出到不同的文档类型。在 Node.js 中,有一个 npm 包可以满足这个需求,名字就是 @leichtgewicht/msee
。
安装
在安装前,你需要安装 Node.js 和 NPM。然后就可以通过以下命令进行安装:
npm install -g @leichtgewicht/msee
全局安装之后,就可以在命令行中使用 msee
命令了。
使用
你可以将你的文档编写成 .md
或者 .msee
的文件,然后使用以下命令进行转换:
msee -i input.md -o output.pdf
这个命令的含义是将 input.md
转换成 output.pdf
文件。可以通过 -f
参数指定要输出的文档格式,目前支持的格式包括 html
和 pdf
。
如果你想要在命令行中直接预览转换之后的效果,可以加上 --preview
参数:
msee --preview -i input.md
这时,msee 会启动一个本地的 HTTP 服务器,并在默认的浏览器中打开文档的预览界面。
示例
下面是一个 .md
文件的示例,它包含了一些基本的标记语言,以及一个表格、一个代码块和一个列表。
-- -------------------- ---- ------- - -- ---------- - ------ - - ------ - - - -------- - -------- - - ----- - ----- - ------------- ------------------ ---------
- 列表项
- 数字列表项
- 数字列表项
这是其他一些普通的文本。
-- -------------------- ---- ------- ------- ------ ------- ---- ----------------------- ------ ---- -------------------------------------- ----------- --------------------- ------ --- -------------------------------------- -- -- --------------------- -------- --- ------------- -------- ---------------------------------------- -------- ------ ---- --------------- - ------------------------------------------------------------------------------ -------- ------------------------------------------------------------------------------------------------------------------------