前言
在前端开发中，我们经常需要编写Markdown文档，Markdown的语法简单易用，但是当我们编写比较复杂的文档时，往往会存在排版混乱，不易阅读的问题。
今天，我想介绍一个npm包——prettier-md，它可以自动化调整Markdown文件的排版，使其更加美观、易读，节省我们许多时间和精力。
安装
使用npm或yarn进行安装：
--- ------- ---------- -----------
或者
---- --- ----- -----------
安装完成后，在项目根目录中创建一个.prettierrc.json文件：
- ------------- ---- -------------- ---- -
接着，在package.json中配置prettier script：
-
------- -------------
---------- --------
---------- -
----------- -------------------------------- ------- --------
-
-这里我们通过--write参数告诉prettier-md工具要将所有匹配到的Markdown格式文件重新格式化并保存。当我们执行npm run prettier时，prettier-md就会对整个项目中的Markdown文件进行格式化。
使用
使用方法非常简单，只需要在Markdown文件中添加以下注释：
---- --------------------- --- ---- ------------------- ---
将这两个注释括起来的内容就不会被prettier-md格式化。
如果你只想忽略注释中的一部分内容，可以采用如下方式：
---- --------------------- --- ------------------------ - ------ --- - ------ --- - - --------------- - ------------ - - ---- --- - ---- --- - ---- ------------------- ---
如果你不想每次手动添加注释，可以在.prettierrc.json文件中配置：
- ------------- ---- -------------- ----- --------- ------ --------------------- ----- ----- ------------------- ----- -
这样，在使用prettier-md格式化Markdown文件时，prettier-md就会自动忽略这两行注释之间的内容。
总结
prettier-md是一款非常实用的npm包，可以自动调整Markdown文档的排版，省去我们手动打造美观文档的烦恼。掌握prettier-md的使用技巧，也非常有助于提高我们Markdown文档的编写效率和质量。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/79442