remark plugin for transforming the README for projects that follow form8ion
conventions
Table of Contents
Usage
Installation
$ npm install @form8ion/remark-readme --save
Example
Import
import {promises as fs} from 'node:fs';
import {remark} from 'remark';
import updateReadme from '@form8ion/remark-readme';
Execute
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}`);
Contributing
Dependencies
$ nvm install
$ npm install
Verification
$ npm test
关于 @form8ion/remark-readme 的常见问题
@form8ion/remark-readme 是什么？
remark plugin for transforming the README for projects that follow form8ion conventions
如何安装 @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 和提交记录判断。