注释读取我

格式8 之后的项目的 README 转换注释插件 公约

目录

• 使用量
  • 安装
  • 示例
    • 导入
    • 执行
• 捐款
  • 依赖关系
  • 核查

使用量

安装

$ npm install @form8ion/remark-readme --save

示例

导入

import {promises as fs} from 'node:fs';
import {remark} from 'remark';
import updateReadme from '@form8ion/remark-readme';

执行

  const file = await remark()
    .use(
      updateReadme,
      {
        usage: 'information about using the project'
      }
    )
    .process(
      `# project-name

Description of the project

<!--status-badges start -->
<!--status-badges end -->

<!--consumer-badges start -->
<!--consumer-badges end -->

<!--contribution-badges start -->
<!--contribution-badges end -->
`
    );

  await fs.writeFile(`${process.cwd()}/README.md`, `${file}`);

捐款

依赖关系

$ nvm install
$ npm install

核查

$ npm test