# @form8ion/remark-readme 中文文档

规范地址：https://npmcn.com/package/%40form8ion/remark-readme/

版本：2\.0\.0
npm 元数据更新时间：2023-07-15T02:45:49.647Z
中文译文更新时间：2026-11-15T08:20:00.152Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40form8ion/remark-readme
原文对照：https://npmcn.com/package/%40form8ion/remark-readme/?lang=original
项目主页：https://npm.im/@form8ion/remark-readme
源码仓库：https://github.com/form8ion/remark-readme

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.6 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：^16\.14 \|\| \>=18
- 运行依赖：3 个
- 首次发布：2021-06-20T05:46:59.181Z
- 最新版本发布：2023-07-15T02:45:49.224Z
- 近 30 天下载量：4954（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

为遵循形式8还原公约的项目转换README的注释插件

## 安装

```sh
npm install @form8ion/remark-readme
```

也可以使用：`pnpm add @form8ion/remark-readme`、`yarn add @form8ion/remark-readme`、`bun add @form8ion/remark-readme`

## README

# 注释读取我

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

[![Node CI Workflow Status](https://github.com/form8ion/remark-readme/workflows/Node.js%20CI/badge.svg)](https://github.com/form8ion/remark-readme/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster)

## 目录

-   [使用量](https://npmcn.com/package/%40form8ion/remark-readme/#readme-usage)
    -   [安装](https://npmcn.com/package/%40form8ion/remark-readme/#readme-installation)
    -   [示例](https://npmcn.com/package/%40form8ion/remark-readme/#readme-example)
        -   [导入](https://npmcn.com/package/%40form8ion/remark-readme/#readme-import)
        -   [执行](https://npmcn.com/package/%40form8ion/remark-readme/#readme-execute)
-   [捐款](https://npmcn.com/package/%40form8ion/remark-readme/#readme-contributing)
    -   [依赖关系](https://npmcn.com/package/%40form8ion/remark-readme/#readme-dependencies)
    -   [核查](https://npmcn.com/package/%40form8ion/remark-readme/#readme-verification)

## 使用量

[![MIT license](https://img.shields.io/github/license/form8ion/remark-readme.svg)](https://npmcn.com/package/%40form8ion/remark-readme/LICENSE) [![npm](https://img.shields.io/npm/v/@form8ion/remark-readme.svg)](https://www.npmjs.com/package/@form8ion/remark-readme) [![Try @form8ion/remark-readme on RunKit](https://badge.runkitcdn.com/@form8ion/remark-readme.svg)](https://npm.runkit.com/@form8ion/remark-readme)

### 安装

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

### 示例

#### 导入

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

#### 执行

```javascript
  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}`);
```

## 捐款

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com/) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org/) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAzNjkgMzY5Ij48Y2lyY2xlIGN4PSIxODkuOSIgY3k9IjE5MC4yIiByPSIxODQuNSIgZmlsbD0iI2ZmZTQyZSIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTUgLTYpIi8+PHBhdGggZmlsbD0iIzhiYjViNSIgZD0iTTI1MSAyNTZsLTM4LTM4YTE3IDE3IDAgMDEwLTI0bDU2LTU2YzItMiAyLTYgMC03bC0yMC0yMWE1IDUgMCAwMC03IDBsLTEzIDEyLTktOCAxMy0xM2ExNyAxNyAwIDAxMjQgMGwyMSAyMWM3IDcgNyAxNyAwIDI0bC01NiA1N2E1IDUgMCAwMDAgN2wzOCAzOHoiLz48cGF0aCBmaWxsPSIjZDk1NjEyIiBkPSJNMzAwIDI4OGwtOCA4Yy00IDQtMTEgNC0xNiAwbC00Ni00NmMtNS01LTUtMTIgMC0xNmw4LThjNC00IDExLTQgMTUgMGw0NyA0N2M0IDQgNCAxMSAwIDE1eiIvPjxwYXRoIGZpbGw9IiMyNGJmYmUiIGQ9Ik04MSAxODVsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzI1YzRjMyIgZD0iTTIyMCAxMDBsMjMgMjNjNCA0IDQgMTEgMCAxNkwxNDIgMjQwYy00IDQtMTEgNC0xNSAwbC0yNC0yNGMtNC00LTQtMTEgMC0xNWwxMDEtMTAxYzUtNSAxMi01IDE2IDB6Ii8+PHBhdGggZmlsbD0iIzFkZGVkZCIgZD0iTTk5IDE2N2wxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjMDBhZmIzIiBkPSJNMjMwIDExMGwxMyAxM2M0IDQgNCAxMSAwIDE2TDE0MiAyNDBjLTQgNC0xMSA0LTE1IDBsLTEzLTEzYzQgNCAxMSA0IDE1IDBsMTAxLTEwMWM1LTUgNS0xMSAwLTE2eiIvPjxwYXRoIGZpbGw9IiMyNGJmYmUiIGQ9Ik0xMTYgMTQ5bDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMxZGRlZGQiIGQ9Ik0xMzQgMTMxbDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMxYmNmY2UiIGQ9Ik0xNTIgMTEzbDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMyNGJmYmUiIGQ9Ik0xNzAgOTVsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzFiY2ZjZSIgZD0iTTYzIDE2N2wxOC0xOCAxOCAxOC0xOCAxOHpNOTggMTMxbDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMzNGVkZWIiIGQ9Ik0xMzQgOTVsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzFiY2ZjZSIgZD0iTTE1MyA3OGwxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjMzRlZGViIiBkPSJNODAgMTEzbDE4LTE3IDE4IDE3LTE4IDE4ek0xMzUgNjBsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzk4ZWRlYiIgZD0iTTI3IDEzMWwxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjYjUzZTAyIiBkPSJNMjg1IDI1OGw3IDdjNCA0IDQgMTEgMCAxNWwtOCA4Yy00IDQtMTEgNC0xNiAwbC02LTdjNCA1IDExIDUgMTUgMGw4LTdjNC01IDQtMTIgMC0xNnoiLz48cGF0aCBmaWxsPSIjOThlZGViIiBkPSJNODEgNzhsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzAwYTNhMiIgZD0iTTIzNSAxMTVsOCA4YzQgNCA0IDExIDAgMTZMMTQyIDI0MGMtNCA0LTExIDQtMTUgMGwtOS05YzUgNSAxMiA1IDE2IDBsMTAxLTEwMWM0LTQgNC0xMSAwLTE1eiIvPjxwYXRoIGZpbGw9IiMzOWQ5ZDgiIGQ9Ik0yMjggMTA4bC04LThjLTQtNS0xMS01LTE2IDBMMTAzIDIwMWMtNCA0LTQgMTEgMCAxNWw4IDhjLTQtNC00LTExIDAtMTVsMTAxLTEwMWM1LTQgMTItNCAxNiAweiIvPjxwYXRoIGZpbGw9IiNhMzM5MDQiIGQ9Ik0yOTEgMjY0bDggOGM0IDQgNCAxMSAwIDE2bC04IDdjLTQgNS0xMSA1LTE1IDBsLTktOGM1IDUgMTIgNSAxNiAwbDgtOGM0LTQgNC0xMSAwLTE1eiIvPjxwYXRoIGZpbGw9IiNlYjZlMmQiIGQ9Ik0yNjAgMjMzbC00LTRjLTYtNi0xNy02LTIzIDAtNyA3LTcgMTcgMCAyNGw0IDRjLTQtNS00LTExIDAtMTZsOC04YzQtNCAxMS00IDE1IDB6Ii8+PHBhdGggZmlsbD0iIzEzYWNiZCIgZD0iTTEzNCAyNDhjLTQgMC04LTItMTEtNWwtMjMtMjNhMTYgMTYgMCAwMTAtMjNMMjAxIDk2YTE2IDE2IDAgMDEyMiAwbDI0IDI0YzYgNiA2IDE2IDAgMjJMMTQ2IDI0M2MtMyAzLTcgNS0xMiA1em03OC0xNDdsLTQgMi0xMDEgMTAxYTYgNiAwIDAwMCA5bDIzIDIzYTYgNiAwIDAwOSAwbDEwMS0xMDFhNiA2IDAgMDAwLTlsLTI0LTIzLTQtMnoiLz48cGF0aCBmaWxsPSIjYmY0NDA0IiBkPSJNMjg0IDMwNGMtNCAwLTgtMS0xMS00bC00Ny00N2MtNi02LTYtMTYgMC0yMmw4LThjNi02IDE2LTYgMjIgMGw0NyA0NmM2IDcgNiAxNyAwIDIzbC04IDhjLTMgMy03IDQtMTEgNHptLTM5LTc2Yy0xIDAtMyAwLTQgMmwtOCA3Yy0yIDMtMiA3IDAgOWw0NyA0N2E2IDYgMCAwMDkgMGw3LThjMy0yIDMtNiAwLTlsLTQ2LTQ2Yy0yLTItMy0yLTUtMnoiLz48L3N2Zz4=)](https://renovatebot.com/)

### 依赖关系

```sh
$ nvm install
$ npm install
```

### 核查

```sh
$ npm test
```

## 常见问题

### @form8ion/remark-readme 是什么？

为遵循形式8还原公约的项目转换README的注释插件

### 如何安装 @form8ion/remark-readme？

在项目目录运行 npm install @form8ion/remark-readme，或使用 pnpm add / yarn add / bun add。

### @form8ion/remark-readme 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/form8ion\_\_remark-readme 是否存在。

### @form8ion/remark-readme 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @form8ion/remark-readme 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^16\.14 \|\| \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @form8ion/remark-readme 可以商用吗？

@form8ion/remark-readme 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @form8ion/remark-readme 的下载量有多少？

根据 npm 官方下载统计，@form8ion/remark-readme 在 2026/10/16 – 2026/11/14 这 30 天内被下载 4,954 次，日均约 165 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @form8ion/remark-readme 还在维护吗？

最新版本 2\.0\.0 发布于 2023/07/15（3 年前）；至今共发布 11 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/06/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。