Python做一个可视化的 mkdocs 操作工具

实现思路

会开发一个 tkinter GUI 应用，它能：

1. 选择 mkdocs 项目目录
2. 执行 mkdocs serve 预览网站
3. 执行 mkdocs build 生成静态文件
4. 显示命令执行的输出日志
5. 处理进程管理（如停止预览服务）

完整代码实现

import tkinter as tkfrom tkinter import ttk, filedialog, scrolledtextimport subprocessimport threadingimport osimport sysclassMkdocsGUI:def__init__(self, root):        self.root = root        self.root.title("Mkdocs 静态网站生成工具")        self.root.geometry("800x600")# 存储进程对象，用于停止预览服务        self.serve_process = None        self.project_path = tk.StringVar()# 创建UI布局        self.create_widgets()defcreate_widgets(self):# 1. 项目路径选择区域        frame_path = ttk.LabelFrame(self.root, text="项目设置")        frame_path.pack(fill="x", padx=10, pady=10)        ttk.Label(frame_path, text="项目目录:").grid(row=0, column=0, padx=5, pady=5, sticky="w")        ttk.Entry(frame_path, textvariable=self.project_path, width=60).grid(row=0, column=1, padx=5, pady=5)        ttk.Button(frame_path, text="选择", command=self.select_project_path).grid(row=0, column=2, padx=5, pady=5)# 2. 操作按钮区域        frame_buttons = ttk.LabelFrame(self.root, text="操作")        frame_buttons.pack(fill="x", padx=10, pady=5)        ttk.Button(frame_buttons, text="预览网站 (mkdocs serve)", command=self.start_serve).grid(row=0, column=0, padx=5, pady=5)        ttk.Button(frame_buttons, text="停止预览", command=self.stop_serve).grid(row=0, column=1, padx=5, pady=5)        ttk.Button(frame_buttons, text="生成静态文件 (mkdocs build)", command=self.build_site).grid(row=0, column=2, padx=5, pady=5)# 3. 日志输出区域        frame_log = ttk.LabelFrame(self.root, text="执行日志")        frame_log.pack(fill="both", expand=True, padx=10, pady=10)        self.log_text = scrolledtext.ScrolledText(frame_log, wrap=tk.WORD)        self.log_text.pack(fill="both", expand=True, padx=5, pady=5)        self.log_text.config(state=tk.DISABLED)  # 设为只读defselect_project_path(self):"""选择mkdocs项目目录"""        path = filedialog.askdirectory(title="选择Mkdocs项目目录")if path:            self.project_path.set(path)            self.log(f"已选择项目目录: {path}")deflog(self, message):"""在日志框中输出信息"""        self.log_text.config(state=tk.NORMAL)        self.log_text.insert(tk.END, f"{message}\n")        self.log_text.see(tk.END)  # 自动滚动到末尾        self.log_text.config(state=tk.DISABLED)defrun_command(self, command, is_serve=False):"""执行mkdocs命令"""try:# 切换到项目目录执行命令            cwd = self.project_path.get() if self.project_path.get() elseNone# 启动子进程            self.serve_process = subprocess.Popen(                command,                cwd=cwd,                stdout=subprocess.PIPE,                stderr=subprocess.STDOUT,                text=True,                bufsize=1,                universal_newlines=True            )# 实时输出日志for line in iter(self.serve_process.stdout.readline, ''):                self.log(line.strip())# 等待进程结束并获取返回码            return_code = self.serve_process.wait()if return_code == 0:                self.log(f"命令执行成功: {' '.join(command)}")else:                self.log(f"命令执行失败，返回码: {return_code}")except Exception as e:            self.log(f"执行命令出错: {str(e)}")finally:ifnot is_serve:                self.serve_process = Nonedefstart_serve(self):"""启动mkdocs serve预览"""ifnot self.project_path.get():            self.log("请先选择项目目录！")returnif self.serve_process and self.serve_process.poll() isNone:            self.log("预览服务已在运行中！")return# 启动新线程执行命令，避免阻塞GUI        command = [sys.executable, "-m", "mkdocs", "serve"] if sys.executable else ["mkdocs", "serve"]        self.log("开始启动预览服务...")        self.log(f"访问地址: http://127.0.0.1:8000")        threading.Thread(target=self.run_command, args=(command, True), daemon=True).start()defstop_serve(self):"""停止mkdocs serve预览"""if self.serve_process and self.serve_process.poll() isNone:            self.log("正在停止预览服务...")            self.serve_process.terminate()            self.serve_process = None            self.log("预览服务已停止")else:            self.log("没有运行中的预览服务！")defbuild_site(self):"""生成静态网站文件"""ifnot self.project_path.get():            self.log("请先选择项目目录！")return# 启动新线程执行命令        command = [sys.executable, "-m", "mkdocs", "build"] if sys.executable else ["mkdocs", "build"]        self.log("开始生成静态网站文件...")        threading.Thread(target=self.run_command, args=(command, False), daemon=True).start()if __name__ == "__main__":# 检查mkdocs是否安装try:        subprocess.run(["mkdocs", "--version"], capture_output=True, check=True)except (subprocess.CalledProcessError, FileNotFoundError):        root = tk.Tk()        root.withdraw()  # 隐藏主窗口        tk.messagebox.showerror("错误", "未检测到mkdocs，请先执行：pip install mkdocs")        sys.exit(1)# 启动GUI    root = tk.Tk()    app = MkdocsGUI(root)    root.mainloop()

代码关键说明

1. 环境依赖检查：程序启动时会检查 mkdocs 是否安装，未安装则弹出错误提示
2. 进程管理：使用 subprocess.Popen 执行命令，通过 terminate() 停止预览服务
3. 多线程处理：命令执行在独立线程中，避免阻塞 GUI 界面
4. 日志实时输出：实时捕获命令行输出并显示在文本框中
5. 路径选择：通过文件对话框选择 mkdocs 项目目录

使用前置条件

1. 安装 mkdocs：pip install mkdocs
2. 确保有一个 mkdocs 项目（可以用 mkdocs new my-project 创建）
3. Python 环境需安装 tkinter（一般Python自带）

操作步骤

1. 运行代码，打开GUI界面
2. 点击「选择」按钮，选择你的 mkdocs 项目目录
3. 点击「预览网站」，等待日志显示服务启动，然后访问 http://127.0.0.1:8000
4. 预览完成后点击「停止预览」
5. 点击「生成静态文件」，生成的文件会在项目目录的 site 文件夹中