# prettifyMarkdown

**Repository Path**: gsunwu/prettifyMarkdown

## Basic Information

- **Project Name**: prettifyMarkdown
- **Description**: Markdown 文档美化工具
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-07
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown 文章美化程序

## BackGround

由于要写大量的文档，且文档格式有要求，手工调节文档格式太慢，因此编写此工具，自动按要求调节文档格式。

## Feature

- 中文和英文之间添加一个空格，并且去除多余空格
- 数字和中文之间添加一个空格，并且去除多余空格

## Usage

```
 python prettifyMarkdown.py <dir> <file_name_patten>
```

- <dir> : 递归遍历目录 <dir> 中的文件。如 `./` 选择当前目录
- <file_name_patten>：过滤要匹配的文件名称的正则表达式，如 `".*.md"` 选择所有的 `.md` 文件

如：

```
 python prettifyMarkdown.py ./ ".*.md"
```

## Test

```
pytest  prettifyMarkdownTest.py
```



## Example

input：

```
熟悉Scala语言，基于Spark   思想, 制作20个程序，每个程序耗时1/2天。 每天24                    小时太有意思了
```

output：

```
熟悉 Scala 语言，基于 Spark 思想, 制作 20 个程序，每个程序耗时 1/2 天。 每天 24 小时太有意思了
```