workbuddy可生成技术文档但默认不渲染markdown;需通过系统提示词强制、正则后处理或json schema映射三种方式启用markdown输出,并支持导出.md文件及网页转markdown。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

WorkBuddy 可以协助生成技术文档,但其对 Markdown 格式的处理存在特定限制。以下是具体说明与应对方式:
一、WorkBuddy 技术文档生成能力说明
WorkBuddy 支持基于自然语言指令或结构化模板生成技术文档,内容可涵盖 API 描述、代码注释解析、部署流程说明等。但输出格式默认为纯文本流,不自动渲染 Markdown 语法,即 **粗体**、*斜体*、```代码块``` 等标记均以原始字符形式显示,不会转换为对应视觉样式。
二、强制启用 Markdown 输出的三种方法
若需确保输出为合规 Markdown 文本(供后续转 PDF/Word 或静态站点使用),可采用以下互斥方案:
1、在系统提示词中嵌入强制 Markdown 指令:于 Skill 的 SKILL.md 文件中,在 system_prompt 区域添加“你必须严格使用标准 GitHub Flavored Markdown 语法输出,禁止任何解释性语句,所有标题用 # 开头,代码块必须用 ``` 包裹并标注语言类型”。
2、添加后处理正则清洗管道:在 WorkBuddy 配置目录下启用 postprocess.yaml,定义规则如“将‘【标题】’前缀替换为‘## ’,将‘→’符号统一转为‘-’并前置空格”,实现输出文本的 Markdown 结构化归一。
3、使用 JSON Schema 预定义输出结构再转 Markdown:在 Skill 脚本中 return 一个符合预设 schema 的字典(含 title、sections、code_examples 等字段),由 WorkBuddy 内置的 md_generator.py 模块依据字段映射规则自动拼装为 Markdown 字符串。
三、导出为 Markdown 文件的操作路径
无论生成过程是否显式使用 Markdown 语法,WorkBuddy 均支持将最终内容导出为 .md 文件,该文件保留全部原始标记字符,可被其他工具识别和渲染:
1、完成文档编辑后,点击右上角「导出」按钮。
通过 jina.ai 将网页抓取为精简的 markdown,用于在需要获取 URL 并获取压缩的 markdown 内容以节省 token。触发词 l...
2、在导出格式列表中选择 Markdown (.md)。
3、指定保存路径,确认导出;生成的文件可直接用于 Git 版本管理、Hugo/Jekyll 构建或 VS Code 预览。
四、网页内容转技术文档的 Markdown 流程
当需将外部技术博客、API 官网等网页沉淀为本地 Markdown 文档时,WorkBuddy 提供专用转换通道:
1、在主界面点击左上角“+”号,选择“新建笔记”。
2、点击编辑区顶部工具栏“导入”按钮右侧下拉箭头,选择“从网页导入”。
3、粘贴目标网页 URL,务必勾选 “启用Markdown转换” 选项,点击“确认导入”。
4、系统加载后显示 Markdown 预览,其中 h1~h6 自动转为 #~######,ul/ol 转为 -/* 列表,图片转为 ![]() 语法,确认无误后点击“保存”。








