Markdown排版

markdown源文件为Typora生成的为准.

Typora虽然支持目录生成, TOC方式生成的目录(但是移植也是问题), 使用也很不方便, 而且目录没有编号还是有点不习惯.

目录编号采用以下规则:

• 一级目录, 不操作, 默认为内容的主标题
• 二级目录采用中文的一, 二, 三...十...
• 二级目录以下, 采用数字1.1, 1.1.1, 1.1.1.1, ....

Features

• 标题自动编号
  • 尝试修正编号异常, 例如: 在二级标题下, 准备使用 ###, 但是敲多了 ####, 避免在嵌套层级过深时, 敲少 #符号.
  • 支持多次使用相同文件进行编号, 原先的编号将自动撤销.
• 添加目录到文件内容(非TOC标签).
• 常见中文符号转为英文符号(默认开启).
• 行首行尾的空格清理.(默认开启)
• 清理隐藏的零宽字符(zero-width character)(默认开启).
• 清理多余的空行, 多行, 保留一行(默认开启).
• 清理多余空格, 连续空格, 保留一个(默认开启).
• 侦测代码区间的标签闭合情况, 提示异常出现的位置.

对于代码区块, 数学公式, 链接, 图片等内容进行了特殊的处理, 数学公式默认的标识符为$$.

注意: 单行的$这种数学公式

new feature:

本地图片自动压缩, 转webp => base64, 以 P > img 标签, 将图片以base64形式嵌入markdown文档.

How

# -f, filepth, 文件路径

# -i, inplace, 内容写入方式, 默认为0, 将排版后的内容写入新的文件(recommend); 1, 覆盖原文件

# -c, contents, 是否在文件标题下添加目录, 默认为0, 不添加; 1 添加

python main.py -f "Git使用指南.md" -i 0 -c 0

Question

• python版本要求: >= 3.9

  # requirements.txt
  pip install loguru

• 如产生异常见logs文件夹下的日志.

关于Typora代码区间标签闭合

Typora显示代码块并不一定需要标签的闭合

由于需要使用两个闭合的标签来判断代码的区间进行排版, 假如没有闭合将导致排版的异常, 简易开启语法自动成对

在代码中也将尝试侦测代码区间的闭合情况