Markdown转换Latex简易实现方案

2022-03-15想法与笔记1173 字

学术文章通常使用Latex进行最后的渲染，但是直接利用Latex语言进行写作并不方便，各种命令细节（例如，命令的花括号的输入）常会打断书写的思路；此外，较为笨重的渲染引擎也很难做到“所见即所得”的写作模式，给文本（尤其是数学公式）修改带来了一定不便；相对的，Markdown作为一种“轻量级”的修饰语言，简单的修饰符，加上完备的工具生态，码字的体验更为流畅。自己读书期间进行学术写作时候，采用了先Markdown写作，再进行Latex转换的步骤。这其中的Markdown到Latex的转换可以利用 Pandoc 进行。但转换后的Latex会有很多附带的不必要的代码，尝试几种方案后，我发现利用正则表达式处理这些不必要的代码是最为直接有效的方法。本文将相关脚本代码以及简单使用说明贴出。

文件说明

代码文件整个结构如下：

1
2
3
4
5
6
7
8


./
├─ src/
│  ├─ YOUR_MD_FILE1.md
│  ├─ YOUR_MD_FILE2.md
│  ├─ folder_inside/
│     ├─ YOUR_MD_FILE3.md
├─ template.latex
├─ md2latex.py

其中

src下存放Markdown文件原稿，原稿可以放在二级（或者任意级）目录下，只要文件在src下且以.md结尾，都会被转换
template.latex 是模版文件，用于指定转换后latex文件形式；你可以在这里指定转换后latex的preamble部分，例如导入相关包的，后面使用说明部分
md2latex.py 文件是markdown 转换 latex的主要脚本，运行其便可开始进行转换。

使用说明

环境安装

整个脚本的代码可以在Github repo FarseaSH/markdown2latex 中下载，或者手动拷贝文章后的代码到本地

脚本运行需要安装Pandoc，具体安装方法参见 Pandoc - Installing pandoc

修改template

根据自身需要修改template.latex文件，可以在这里加入相关导入的包，调整文本相关的格式。模版文件中的 $body$ ，会被替换为Markdown文本对应的Latex文本。

例如，下面的模版代码，为每个转换后的Latex文件，在preamble部分添加命令，载入amsfonts数学符号包、hyperref文本链接辅助包，并且在正文前添加目录。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


\\documentclass{ctexart}

\\usepackage{amsfonts}
\\usepackage{hyperref}

\\begin{document}

\\tableofcontents

$body$

\\end{document}

进行转换

将所需要转换的Markdown文件放入src目录下，运行md2latex.py脚本可以完成对应转换，所有对应生成的Latex文件都默认放在output文件夹下。

代码

Python主要代码md2latex.py

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60


# ===================================================== #
# A simple Python scirpt to transform Markdown to Latex #
# From: <https://www.yyshao.com>                        #
# ===================================================== #

import re
import os

SOURCE_DIR = "src"
OUTPUT_DIR = "output"

REPLACE_PATTERNS = [
    r"^\\s*\\\\hypertarget\\{.*\\}\\{%\\n",
    r"\\\\label\\{.*\\}\\}",
    r"^\\s*\\\\tightlist\\n",
    r"^\\\\def\\\\labelenumi\\{\\\\arabic\\{enumi\\}\\.\\}\\n"
]

def main():
    # find all the markdown(md) files
    mdFilesList = []
    for path, subdirs, files in os.walk(SOURCE_DIR):
        for file in files:
            if file.endswith('.md'):
                mdFilesList.append(os.path.join(path, file))

    currentDirPath = os.path.dirname(os.path.realpath(__file__))
    for mdFile in mdFilesList:
        md2Latex(mdFile, currentDirPath=currentDirPath)
        modifyLatexFile(mdFile)
    

def modifyLatexFile(filePath):
    filePath = os.path.splitext(filePath)[0].replace(SOURCE_DIR, OUTPUT_DIR) + ".tex"
    print(filePath)

    with open(filePath, 'r') as file:
        data = file.read() 

        for pattern in REPLACE_PATTERNS:
            data = re.sub(pattern, '', data, flags=re.MULTILINE)
        
        if os.path.split(filePath)[1] == "README.tex":
            data = re.sub("section", "chapter", data, flags=re.MULTILINE)

    with open(filePath, 'w') as file:
        file.write(data)   
            

def md2Latex(filePath, currentDirPath):
    outputPath = os.path.splitext(filePath)[0].replace(SOURCE_DIR, OUTPUT_DIR) + ".tex"
    outputPath = os.path.join(currentDirPath, outputPath)

    os.system(f"mkdir -p '{os.path.split(outputPath)[0]}'")
    CMD = f"pandoc -o '{outputPath}' --template='{os.path.join(currentDirPath, 'template.latex')}' '{os.path.join(currentDirPath, filePath)}'"
    
    os.system(CMD)

if __name__ == "__main__":
    main()

latex模版文件template.latex

1
2
3
4
5


\\documentclass[a4paper]{article}

\\begin{document}
$body$
\\end{document}

Python

Markdown