@hbsnow/rehype-sectionize

中文文档
1.0.7发布于 2023/01/28MITTypeScriptES Module近 30 天下载 4.4万

rehype plugin that wraps section based on heading

原始使用文档
文档目录7 节
  1. Motivation
  2. Install
  3. Sample
  4. Input
  5. Output
  6. Options
  7. License

rehype-sectionize

test workflow codecov

Motivation

There is already rehype-section in the library for sectioning. But it could not change the class of section. In addition, sections could not have the slug of heading in the data attribute. I was referred rehype-section. Thanks.

Install

npm i -D @hbsnow/rehype-sectionize

Sample

Input

<h1 id="h1-id">h1</h1>
<h2 id="h2-id">h2</h2>
<h3 id="h3-id">h3</h3>

Output

<section class="heading" data-heading-rank="1" aria-labelledby="h1-id">
  <h1 id="h1-id">h1</h1>
  <section class="heading" data-heading-rank="2" aria-labelledby="h2-id">
    <h2 id="h2-id">h2</h2>
    <section class="heading" data-heading-rank="3" aria-labelledby="h3-id">
      <h3 id="h3-id">h3</h3>
    </section>
  </section>
</section>

Options

optiontypedefaultdescription
propertieshastscript.Properties{}Attributes assigned to section
enableRootSectionbooleanfalseSection to wrap all
rankPropertyNamestringdataHeadingRankName of rank data attribute
idPropertyNamestringariaLabelledbyName of id data attribute

License

MIT © hbsnow

版本与发布记录

@hbsnow/rehype-sectionize 共发布 6 个版本,首次发布于 2022/12/16;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.7latest2023/01/283 年前
1.0.62023/01/273 年前
1.0.52023/01/273 年前
1.0.32022/12/183 年前
1.0.22022/12/163 年前
1.0.12022/12/163 年前

关于 @hbsnow/rehype-sectionize 的常见问题

@hbsnow/rehype-sectionize 是什么?

rehype plugin that wraps section based on heading

如何安装 @hbsnow/rehype-sectionize?

在项目目录运行 npm install @hbsnow/rehype-sectionize,或使用 pnpm add / yarn add / bun add。

@hbsnow/rehype-sectionize 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@hbsnow/rehype-sectionize 支持 ESM 还是 CommonJS?

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

@hbsnow/rehype-sectionize 需要什么版本的 Node.js?

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

@hbsnow/rehype-sectionize 可以商用吗?

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

@hbsnow/rehype-sectionize 的下载量有多少?

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

@hbsnow/rehype-sectionize 还在维护吗?

最新版本 1.0.7 发布于 2023/01/28(3 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/12/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。