# markdown-numbering-tool

**Repository Path**: yanzuwuplus/markdown-numbering-tool

## Basic Information

- **Project Name**: markdown-numbering-tool
- **Description**: markdown-numbering-tool
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-22
- **Last Updated**: 2025-11-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[TOC]

# 1. 程序的功能

顾名思义，程序的功能就是自动为 Markdown 文档标题编号

## 1.1 可选项

程序有三个可选项：

1. 第一个一级标题的开始序号（**默认从 1 开始，只能填写非负整数**）
2. 数字编号与标题内容之间是否加空格（加空格示例：1. 标题 vs 不加空格示例：1.标题，默认开启）
3. 二级及以下标题数字编号后是否加.符号（加点示例：1.1. 标题 vs 不加点示例：1.1 标题，默认关闭）

## 1.2 单文件模式

在单文件模式下，选择 Markdown 文件后，文件的输出路径默认是输入文件的路径（可以点击选择路径按钮修改输出路径，也可以直接在输入框修改输出路径），但会为输出文件添加 `-numbered` 后缀

例如，原文件的路径是 `C:/folder/sourceFile.md`，输出文件的路径默认就是  `C:/folder/sourceFile-numbered.md`

![image-20250122011142381](assets/image-20250122011142381.png)

## 1.3 批处理模式

在批处理模式下，可以选择一个文件夹，程序会自动为文件夹下的所有 Markdown 文件的标题标上数字编号

**批处理模式下只可以选择输出路径，不能更改输出的文件名**，输出文件的文件名与原文件相同，不过会添加 `-numbered` 后缀，例如，原文件的路径是 `C:/folder/sourceFile.md`，输出文件的路径默认就是  `C:/folder/sourceFile-numbered.md`

# 2. 实现效果

左边是编号前，右边是编号后

![image-20250113155049382](assets/image-20250113155049382.png)

# 3. 如何运行程序

## 3.1 通过源码运行

源码已经上传到 Gitee 上：[markdown_numbering_tool](https://gitee.com/yanzuwuplus/markdown-numbering-tool)

![image-20250122011814529](assets/image-20250122011814529.png)

## 3.2 通过exe文件运行

exe 文件已放在 Releases 下：[markdown-numbering-tool:1.0.1](https://gitee.com/yanzuwuplus/markdown-numbering-tool/releases/tag/1.0.1)

![image-20250522045752848](assets/image-20250522045752848.png)