引言
在前端开发中,文档编写是不可避免的一项工作。而随着项目的不断发展、文件的增多,文档维护变得越来越困难。这时候,一个好用的 markdown 工具就变得非常重要了。于是我们介绍一个非常好用的 npm 包 whatmd。
whatmd 是什么?
whatmd 是一个支持 Markdown 语法的文件转换工具。它可以帮助你将 Markdown 格式的文件转换为 HTML, PDF, Word, PPT 等其他格式。
如何安装 whatmd?
安装 whatmd 通过 npm 安装即可:
--- ------- -- ------
如何使用 whatmd?
whatmd 的使用非常简单,只需要以 .md
为后缀编写 markdown 文件,然后运行命令即可:
------ -------------
引入样式文件
默认情况下,whatmd 转换后的页面样式非常简单,只有最基本的样式,无法满足我们的需求。所以我们可以通过 -s
参数来引入自定义的样式文件。如:
------ ------------- -- -------------------
导出 PDF 文件
使用 whatmd 将 .md
格式转换为 PDF 格式也非常简单,只需要使用 -p
参数即可,如:
------ ------------- --
默认情况下,whatmd 将使用 A4 做为默认纸张大小。你可以使用 -h
和 -w
参数来指定自定义的高度和宽度。
导出 Word, PPT 文件
whatmd 还可以将 .md
文件转换为 Word, PPT 文件。使用 -w
或 -P
即可,如:
------ ------------- --
------ ------------- --
示例代码
示例代码如下:
- ------ -- ------ --------- ------------- ------------------ ---------
这是一张图片:
表格:
一个表格 | 说明 |
---|---|
1 | 一 |
2 | 二 |
3 | 三 |
-- ---- ------ ---------------------------------------- ------ --------------------------------------------------------------------- --------- --------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------