使用脚本快速生成mkdocs.yaml中nav的文件

约 270 个字 58 行代码 预计阅读时间 2 分钟

View Times

---

点击下载

py

import os

# 指定文件列表的路径和输出目录
file_list_path = r'xxxx\nav.txt'  # 将mkdocs.yaml中nav另存为txt
output_dir = 'Your_Project_path\\docs'  # 注意使用双反斜杠或原始字符串

# 读取文件列表并获取路径列表
def get_md_file_paths_from_list(file_list_path):
    md_file_paths = []
    try:
        with open(file_list_path, 'r', encoding='utf-8') as file:
            for line in file:
                # 去除行尾的换行符和行首/尾的空白字符
                line = line.strip()
                # 检查行是否为空或是否只包含描述（即没有“: ”分隔符和路径）
                if line and ': ' in line:
                    # 分割描述和路径/文件名
                    description, file_path = line.split(': ', 1)
                    # 去除路径/文件名两侧的空格（如果有的话）
                    file_path = file_path.strip()
                    # 检查路径/文件名是否为非空字符串
                    if file_path:
                        # 将路径/文件名添加到列表中（这里假设路径/文件名已经是正确的）
                        md_file_paths.append(file_path)
                # 如果行不包含“: ”，则可以选择在这里添加其他处理逻辑（比如打印警告或忽略该行）
                # else:
                #     print(f"Warning: The line '{line}' does not contain a path.")
    except FileNotFoundError:
        print(f"Error: The file {file_list_path} was not found.")
    except Exception as e:
        print(f"An error occurred: {e}")
    return md_file_paths

# 创建Markdown文件
def create_markdown_files(md_file_paths, output_dir):
    for file_path in md_file_paths:
        # 确保文件名以 .md 结尾（如果不是，则可以在这里添加逻辑来处理，比如自动添加 .md 扩展名）
        if not file_path.endswith('.md'):
            # 这里选择打印警告并跳过该文件，但您可以根据需要修改这一行为
            print(f"Warning: The file path '{file_path}' does not have a .md extension. Skipping.")
            continue

        # 构建完整的文件路径
        full_file_path = os.path.join(output_dir, file_path)

        # 创建文件的目录（如果不存在）并写入默认内容
        os.makedirs(os.path.dirname(full_file_path), exist_ok=True)
        with open(full_file_path, 'w', encoding='utf-8') as file:
            file.write('---\ntags:\n---\n\n#')

# 执行脚本
md_file_paths = get_md_file_paths_from_list(file_list_path)
create_markdown_files(md_file_paths, output_dir)

脚本说明

这个脚本用于从一个包含文件列表的文本文件中读取路径，并在指定的输出目录中创建对应的 Markdown 文件。

文件列表格式

文件列表应该是一个文本文件，每行包含一个描述和文件路径，用 : 分隔。例如：

描述1: path/to/file1.md
描述2: path/to/file2.md

使用方法

1. 将 navtest.py 脚本下载到你的项目目录。
2. 修改脚本中的 file_list_path 和 output_dir 变量，分别指定文件列表的路径和输出目录。
3. 运行脚本，生成的 Markdown 文件将会被创建在指定的输出目录中。

示例

假设你的文件列表 nav.txt 内容如下：

首页: index.md
关于: about.md
文档: docs/documentation.md

运行脚本后，将会在输出目录中生成以下文件：

output_dir/
├── index.md
├── about.md
└── docs/
    └── documentation.md

每个生成的 Markdown 文件将包含以下默认内容：

---
tags:
---

#

更多资源

• MkDocs 官方文档
• Python 文件操作

评论