关于使用MkDocs-Material文档仓库进行快速预览¶

约 281 个字 • 49 行代码

由于我的blog越写越多，如果想要在推送到github前进行效果预览，在原本的本地仓库中进行 mkdocs serve 时，第一次构建以及每次修改后的构建都要等待很久，所以就把除了md文档和git的其他文件直接复制到了另一个文件夹中，将要预览的md文档放在这个“副本仓库”下的相应的位置，再进行预览生成速度就很快了。

但需要注意的是，复制了除了md文档和git的其他文件之后直接进行 mkdocs serve 预览可能会因为没有git而产生如下的报错

Failure

INFO    -  Building documentation...
WARNING -  [git-revision-date-localized-plugin] Unable to find a git directory and/or git is not installed. To ignore
           this error, set option 'fallback_to_build_date: true'
Traceback (most recent call last):
  ...
  File "C:\Users\Ronald\AppData\Local\Programs\Python\Python310\lib\site-packages\git\repo\base.py", line 289, in __init__
    raise InvalidGitRepositoryError(epath)
git.exc.InvalidGitRepositoryError: C:\Github\blog-test\docs

可以通过在这个文件夹中初始化git，并把所有文件commit来(git中没有commit记录会报错)解决这个报错。

又因为每次在两个文件夹之间复制md文档以及引用的图片让我感到很麻烦😡，于是~~一气之下~~就写了python来实现(些许)自动化的流程

import shutil
import sys
import re
import os

original_repo = os.path.normpath(os.path.join(os.getcwd(), '..', 'MyPamphlet-Blog'))

def extract_image_paths(markdown_content):
    # 正则表达式匹配Markdown中的图片语法：![alt text](path/to/image)
    pattern = r'!\[(.*?)\]\((.*?)\)'
    images = re.findall(pattern, markdown_content)
    image_paths = [image[1] for image in images]
    return image_paths

def get_md_content(md_file_path):
    with open(md_file_path, 'r', encoding='utf-8') as file:
        content = file.read()
    return content

if __name__ == "__main__":
    if len(sys.argv) != 2:
        print("Usage: python test.py <markdown_file_path>")
        sys.exit(1)

    target_md_file = sys.argv[1]
    content = get_md_content(os.path.join(original_repo, 'docs', 'posts', target_md_file))

    image_paths = extract_image_paths(content)
    print("检测到的图片相对路径:")
    for path in image_paths:
        print(path)

    shutil.rmtree('docs/posts/')
    shutil.rmtree('docs/images/')
    os.makedirs('docs/posts/')
    os.makedirs('docs/images/')

    shutil.copy(os.path.join(original_repo, 'docs', 'posts', target_md_file), 'docs/posts')
    for path in image_paths:
        shutil.copy(os.path.join(original_repo, 'docs', 'images', path), 'docs/images')
    print("Markdown文件和图片已移动到docs目录下")

最后更新: 2025-03-28
创建日期: 2025-03-28

关于使用MkDocs-Material文档仓库进行快速预览¶

评论