Markdown 进度条项目教程

Markdown 进度条项目教程

项目介绍

markdown-progress 是一个开源项目，旨在为 Markdown 文档添加进度条功能。该项目由 gepser 开发，允许用户在 Markdown 文档中插入进度条，以便更好地跟踪和管理进度。

项目快速启动

安装

首先，克隆项目仓库到本地：

git clone https://github.com/gepser/markdown-progress.git

使用

在 Markdown 文档中添加进度条，可以使用以下格式：

![Progress](https://geps.dev/progress/10)

将 10 替换为你需要的进度百分比。

应用案例和最佳实践

案例一：项目进度跟踪

在项目文档中，可以使用进度条来展示当前项目的完成情况：

# 项目进度

## 模块 A

![Progress](https://geps.dev/progress/30)

## 模块 B

![Progress](https://geps.dev/progress/70)

案例二：学习进度展示

在学习笔记中，可以使用进度条来展示学习进度：

# 学习进度

## 章节 1

![Progress](https://geps.dev/progress/100)

## 章节 2

![Progress](https://geps.dev/progress/50)

典型生态项目

markdown-it-progress

markdown-it-progress 是一个与 markdown-it 解析器配合使用的插件，可以在 Markdown 文档中插入进度条。该项目提供了更灵活的配置选项和更丰富的功能。

安装

npm install --save markdown-it-progress

使用

var md = require('markdown-it')();
var markdownItProgress = require('markdown-it-progress');

md.use(markdownItProgress, {
  // 可选配置项
  render: 'svg'
});

var src = '```progressBar\n[["a", 2]]\n```';
var res = md.render(src);
console.log(res);

通过以上步骤，你可以在 Markdown 文档中轻松添加进度条，并根据需要进行自定义配置。