kdown

格式的纯文本自学笔记方便日后查阅。

久而久之要创建的笔记文件越来越多如果再要求这些文件都具备统一的格式例如文件名的命名风格、统一的标题模板等等无形中就会多出不少工作量。

之前我都是用

PowerShell

来批量生成这些文件夹和文件名虽然脚本编写比较繁琐但可以一劳永逸倒也划算前段时间入坑

Python

再复杂的需求也可以拆分成若干个可以轻松实现的单元。

多行的批量处理可以先简化为某一行的处理

toc.md

是文件夹创建该文件夹并更新当前路径curr_path以便后续笔记文件引用是文件根据当前路径生成对应的笔记文件同时写入文本内容。

具体实现

判断行首是否是数字如果是说明是章节标题starts_with_digit

re.match(r^(\d)\.,

添加本章的章节内容仅占位用文件夹没有文本内容contents.append(placeholder)#

添加本章的文件名file_names.append(file_name)#

更新章节号chp_num

添加该小节的文本内容file_names.append(sec_file_name)#

添加该小节的文件名contents.append(sec_content)#

starts_with_digit

file_or_path.endswith(.md):file

file_or_pathwith

(Ch01_Getting_Started_with_GitHub_Actions.md,

1)pttn

(Ch01_1_Introduction_to_the_Course.md,

Ch01.1

fCh{chapter_num.zfill(2)}_{section_num}content_part

dashed(line,

f{header_part}_{content_part}title_content

f##

Ch{chapter_num.zfill(2)}.{section_num}

{line}return

(f{sanitize_filename(file_name)}.md,

title_content)4.4.

fCh{num.zfill(2)}_{dashed(content,

_)}return

generate_files.py不到两秒就生成了所有的文件夹和

Markdown

一定要小步走多迭代按抽象层次依次实现每一层的函数逻辑方便后续管理读取每一行文本都会包含一个

换行符需要用

脚本文件本身也删没了的杯具。

。

尽量避免引用全局变量多用参数传参本例必须使用全局变量以实时获取当前的文件夹名称和路径主体框架确定后今后只需要修改文件夹和文件的处理逻辑就可以适应不同的原始数据。

os.makedirs(path,

exist_okTrue)

异常。

重视代码注释和函数文档docstring的书写既方便别人也方便自己主要是写给自己看的