# merge

**Repository Path**: yangjh/merge

## Basic Information

- **Project Name**: merge
- **Description**: 利用Python，合并多个MarkDown文档，并将其转化为Word文档。
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2018-11-26
- **Last Updated**: 2025-05-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# merge

## 项目介绍

利用Python，合并多个MarkDown文档，并将其转化为Word文档。这样可以利用事先做好的word文档样式，一定程度上实现word文档的内容与样式分离，减少使用word时重复设置格式的烦恼。

## 安装教程

1. 需要安装pandoc，并能全局运行。
    ```bash
    brew install pandoc
    ```
2. 需要安装python3。
    ```bash
    brew install python3
    ```
3. 将merge.py复制到合适路径，并给予运行权限。
    ```bash
    chmod +x merge.py
    ```
4. 将merge.py加入到系统变量path中，以便能全局运行。
    ```bash
    vim ~/.bash.profile
    ```
    添加如下内容：
    ```bash
    export PATH="/Users/ncsxbmu/document/works/www/merge:$PATH"
    ```
    之后：
    ```bash
    source ~/.bash.profile
    ```

## 使用说明

```bash
usage: merge.py [-h] [--contents CONTENTS] [--source SOURCE]
                [-td TARGERDICTIONARY] [-r REFERENCEDOCX] [-t TARGET]

合并多个markdown文件并转化为docx文件

optional arguments:
  -h, --help            show this help message and exit
  --contents CONTENTS, -c CONTENTS
                        目录文件，用来指定合并对象
  --source SOURCE, -s SOURCE
                        合并后的文件名
  -td TARGERDICTIONARY, --targerDictionary TARGERDICTIONARY
                        目标文件所在目录
  -r REFERENCEDOC, --referenceDocx REFERENCEDOCX
                        word模板文件
  -t TARGET, --target TARGET
                        目标文件名
```

1. 使用`content.md`来指定多个文件所在位置，这样就可以将长文档拆分成多个小的文档，有助于提高效率。`merge.py`会读取其中每行的文件名，然后合成。例如：
    ```markdown
    * [第一部分](1.md)
    * [2](2.md)
    * [3](/sc/3.md)
    ```
2. 在目标文件夹（默认值为`/Users/ncsxbmu/Documents/我的坚果云/`)，存放名为`OfficalDocument.docx`文件，作为word文档样式模板。
3. 使用`merge.py`，指定合成后的docx文件名：
    ```bash
    merge.py -t 合成后.docx
    ```
    这样将在目标文件夹生成名为`合成后.docx`的文档。

## 后续特性

1. 增加参考文献支持。
1. 增加交叉引用支持。

## 参与贡献

1. Fork 本项目
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request