介绍
npm 是一个 JavaScript 包管理器，它可以让我们方便地安装、更新、升级和卸载 JavaScript 包。在前端开发中，我们经常需要使用一些库、框架或者工具来辅助我们的开发。而其中一个很重要的问题就是如何更好地管理这些包的版本。
@itrulia/fractal-variant-readme 是一个 npm 包，它提供了一个方便的方法来创建和管理项目文档。它支持多版本文档的创建和管理，能够让你更加方便地维护你的文档，也能够提高你的开发效率。
使用步骤
- 安装 @itrulia/fractal-variant-readme
npm install @itrulia/fractal-variant-readme --save-dev
- 引入和初始化
-- -------------------- ---- -------
----- -------------------- - -------------------------------------------
-- ---
----- ------ - ----------------------
----- -------------
----- ---------
--------- -
-
----- ---------
----- ----------------
--
-
----- ---------
----- ----------------
--
--
---- 写作
@itrulia/fractal-variant-readme 支持 Markdown 格式的文档。你可以在你的项目目录下创建一个 readme.md 文件，同时在相应的版本目录下创建一个同名的文件。这样，当你运行 fractalVariantReadme 方法时，它会将这些文件合并成一个包含多版本文档的 HTML 文件。
你可以在你的 Markdown 文件中使用一些自定义的语法来定义文档的标题、版本、概述、内容、代码和示例等。这些语法都是以 @variant 开头的，具体的语法规则可以参考 npm 包 @itrulia/fractal-variant-readme 的文档。
- 生成文档
readme.generate();
这一步会将 Markdown 文件编译成 HTML 文件，并合并成一个包含多版本文档的 HTML 文件。你可以在你的浏览器中打开这个文件来查看你的文档。
如果你想根据不同的版本生成不同的文档，你可以使用下面的方法：
readme.generate('v1.0.0'); // 生成 v1.0.0 版本的文档
readme.generate('v2.0.0'); // 生成 v2.0.0 版本的文档- 发布
完成以上步骤后，你可以将 docs 目录下生成的 HTML 文件部署在一个 Web 服务器上，并将它们分享给你的团队或者用户。
示范代码
-- -------------------- ---- -------
----- -------------------- - -------------------------------------------
----- ------ - ----------------------
----- -------------
----- ---------
--------- -
-
----- ---------
----- ----------------
--
-
----- ---------
----- ----------------
--
--
---
------------------# @variant title: Hello World @variant version: v1.0.0 Hello World!
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bc3967216659e2442af