# @hackmd/markdown-it-task-lists 中文文档

规范地址：https://npmcn.com/package/%40hackmd/markdown-it-task-lists/

版本：2\.1\.4
npm 元数据更新时间：2024-03-27T03:39:54.760Z
中文译文更新时间：2026-11-17T05:42:22.895Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40hackmd/markdown-it-task-lists
原文对照：https://npmcn.com/package/%40hackmd/markdown-it-task-lists/?lang=original
项目主页：https://github.com/revin/markdown-it-task-lists#readme
源码仓库：https://github.com/revin/markdown-it-task-lists

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

- 包体积（解压后）：15.7 kB，11 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2020-05-13T09:34:51.056Z
- 最新版本发布：2024-03-27T03:39:54.270Z
- 近 30 天下载量：17001（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

创建 GitHub 风格任务列表的标记下- 它插件

## 安装

```sh
npm install @hackmd/markdown-it-task-lists
```

也可以使用：`pnpm add @hackmd/markdown-it-task-lists`、`yarn add @hackmd/markdown-it-task-lists`、`bun add @hackmd/markdown-it-task-lists`

## README

# 任务列表

A 类 [缩放](https://www.npmjs.com/package/markdown-it) 创建 GitHub 样式的插件 [任务列表](https://github.com/blog/1825-task-lists-in-all-markdown-documents)

[![Greenkeeper badge](https://badges.greenkeeper.io/revin/markdown-it-task-lists.svg)](https://greenkeeper.io/) [![Build Status](https://travis-ci.org/revin/markdown-it-task-lists.svg?branch=master)](https://travis-ci.org/revin/markdown-it-task-lists) [![Code Climate](https://codeclimate.com/github/revin/markdown-it-task-lists/badges/gpa.svg)](https://codeclimate.com/github/revin/markdown-it-task-lists)

## 它会做什么

-   构建 [任务/待办事宜列表](https://github.com/blog/1825-task-lists-in-all-markdown-documents) 在下限列表中,从项目开始 `[ ]` 或者说 `[x]`。 。 。 .
-   没别的了

### 为什么这样有用?

当您有带有核对表的下标文档时, 渲染 HTML 复选框 列表项目外的外观比原始方括号要好.

## 安装

```sh
npm install markdown-it-task-lists
```

## 使用量

使用与普通的平减插件相同 :

```js
var md = require('markdown-it');
var taskLists = require('markdown-it-task-lists');

var parser = md().use(taskLists);

var result = parser.render(...); // markdown string containing task list items
```

已制成的复选框已禁用; 要更改此选项, 请将真实值传递到 页:1 `enabled` 插件选项的属性 :

```js
var parser = md().use(taskLists, {enabled: true});
```

如果您想将已提供的清单项目包成 `<label>` uX 的元素 ,将一个真实值传递到 `label` 插件选项的属性 :

```js
var parser = md().use(taskLists, {label: true});
```

在复选框传递一个真实值后添加标签 `labelAfter` 属性 :

```js
var parser = md().use(taskLists, {label: true, labelAfter: true});
```

**说明:** 此选项需要 `label` 选项是真实的.

当然,这些选择可以合并.

### 浏览器使用

如果您使用此模块中可用的版本之一 `dist/` 直接输入 包含其中的浏览器 `<script>` 元素,将可用 全球 `window.markdownitTaskLists`。 。 。 .

## 测试

```sh
npm install
npm test
```

## 许可证

公务员制度委员会

## 常见问题

### @hackmd/markdown-it-task-lists 是什么？

创建 GitHub 风格任务列表的标记下- 它插件

### 如何安装 @hackmd/markdown-it-task-lists？

在项目目录运行 npm install @hackmd/markdown-it-task-lists，或使用 pnpm add / yarn add / bun add。

### @hackmd/markdown-it-task-lists 支持 TypeScript 吗？

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

### @hackmd/markdown-it-task-lists 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @hackmd/markdown-it-task-lists 可以商用吗？

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

### @hackmd/markdown-it-task-lists 的下载量有多少？

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

### @hackmd/markdown-it-task-lists 还在维护吗？

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

