什么是 markdown-magic-package-scripts?
markdown-magic-package-scripts 是一个 npm 包,可以让你在 Markdown 文件中,直接引用 package.json 中的信息,比如版本号、项目名称等,并且可以自定义输出格式。
markdown-magic-package-scripts 的安装
在命令行中输入以下命令即可安装:
--- - ------------------------------
markdown-magic-package-scripts 的使用
在 Markdown 文件中,我们可以使用以下代码来引用 package.json 中的信息:
---- ---------------------------- ------------- --- ---- -------------------------- ---
然后在项目根目录下,创建一个 .magic.md 文件,在这个文件中,我们可以使用以下代码来自定义输出信息的格式:
-- ------- ---- - ----- ---------- - -------- ------------- - ------- ------------
其中,{{name}}、{{version}}、{{author}} 等变量就是在 Markdown 文件中引用 package.json 中信息的对应关系。
最后,在项目的 package.json 文件中添加以下代码:
---------- - ------------- ----------------- ------------- --------------- --- --
然后在命令行中输入以下命令:
--- --- ----------
就可以生成对应的 Markdown 文件了,生成后的文件中,就会自动填充 package.json 中的信息。
markdown-magic-package-scripts 的示例
在项目根目录下,创建一个 test.md 文件,添加以下内容:
- -- ------- ---- ---------------------------- ------------- --- ---- -------------------------- ---
在项目根目录下,创建一个 .magic.md 文件,添加以下内容:
-- ------- ---- - ----- ---------- - -------- ------------- - ------- ------------
在项目的 package.json 文件中添加以下代码:
---------- - ------------- ----------------- ------------- --------------- --- --
在命令行中输入以下命令:
--- --- ----------
生成的 test.md 文件中,会自动填充项目的名称、版本号和作者信息,格式如下:
- -- ------- -- ------- ---- - ----- --- -------- - -------- ------- - ------- ----- -----
总结
使用 markdown-magic-package-scripts,可以便利地在 Markdown 文件中引用 package.json 中的信息,减少重复工作,提升效率。同时,还可以自定义输出格式,让 Markdown 文件更加灵活、美观。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eedaecbb5cbfe1ea0610ee3