如何在 VSCode 中通过 CodeGeeX 快速生成 Markdown 技术文档

胖敏吖_3687

胖敏吖_3687

2026-06-22

856人浏览

原创

codegeex可自动生成规范markdown文档骨架、readme及表格。需在vscode安装插件并登录,按提示输入指令触发生成,严格校验标题层级、空行分隔、表格对齐语法及项目上下文准确性。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如何在 vscode 中通过 codegeex 快速生成 markdown 技术文档

你需要为新项目快速产出结构清晰、层级规范的 Markdown 技术文档,避免手动敲写标题层级、遗漏关键模块或缩进错位导致渲染异常。

自动生成标准文档骨架

1、在 VSCode 中新建空白 .md 文件,确保已安装并启用 CodeGeeX 官方插件,且登录状态有效。

2、输入提示词:“生成一份关于‘微服务网关设计规范’的技术文档 Markdown 骨架,含一级标题、二级功能模块标题、三级要点说明占位符”,注意末尾不加句号。

3、按下 Ctrl+Enter(Windows/Linux)或 Cmd+Enter(macOS)触发生成;【若未响应,请确认光标位于空行且无选中文本】

4、检查输出:所有标题必须以正确数量的 # 开头(如 ## 接口路由策略),# 后紧跟一个空格;任意两个标题之间必须有空行分隔。

一键生成 README.md 项目文档

方法一:VS Code 插件直连项目上下文

1、在 VSCode 中打开代码项目根目录,确保目录下存在 package.jsonrequirements.txtpyproject.toml 等标志性配置文件。

2、按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS),输入 “CodeGeeX: Generate README”,回车执行。

3、等待插件分析完成——它会读取源码入口函数、依赖声明和注释块,不是简单关键词匹配。

4、生成的 README.md 将自动在编辑器中打开;【务必核对“使用示例”章节中的命令是否与你实际的启动脚本一致,例如 python main.py 而非 npm start】

Xlsx To Markdown
Xlsx To Markdown

文档转 Markdown 转换器 - 将 DOCX、PPTX、Excel 文件转换为 Markdown。用于从 Word 文档、PowerPoint 演示文稿或 E... 提取内容。

下载

方法二:Web 端上传压缩包批量处理

1、访问 CodeGeeX 官网,进入“文档生成”页面,点击“上传项目压缩包”。

2、上传 .zip.tar.gz 文件,确保压缩包顶层目录直接包含 src/tests/ 和配置文件,不要有多余父文件夹。

3、勾选“提取 API 接口说明”选项(如有),该选项会扫描 @api 注释或 OpenAPI YAML 片段。

4、点击“开始生成”,预览时重点看“依赖列表”是否完整列出 requirements.txt 中所有包名及版本号。

用 CodeGeeX 创建格式完美的 Markdown 表格

第一步:在 VSCode 编辑器中,光标置于 .md 文件任意位置,输入英文提示词:create a markdown table with 4 columns: Module, Description, Status, Owner

第二步:按下 Tab 键或点击补全弹窗中的“插入”,CodeGeeX 将生成含表头、分隔线和对齐语法的完整表格。

第三步:检查分隔行是否为 |:---|:---:|---:|---| 这类带冒号的格式——缺失冒号会导致 GitHub 预览时全部左对齐,无法实现居中或右对齐效果。

第四步:若需调整某列对齐方式,直接修改对应分隔符:左对齐用 :--,居中用 :-:,右对齐用 --:

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode codegeex markdown

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
WorkBuddy核心功能与实操模式
WorkBuddy核心功能与实操模式

深入探索WorkBuddy的强大功能。本专题包含智能问答、文档处理、会议纪要生成、日程管理、任务协作等核心模块的操作指南与最佳实践。通过图文并茂的教程,助您快速上手,最大化发挥WorkBuddy的办公效能。

2026.04.09

522

19

WorkBuddy核心功能与实操模式
WorkBuddy核心功能与实操模式

深入探索WorkBuddy的强大功能。本专题包含智能问答、文档处理、会议纪要生成、日程管理、任务协作等核心模块的操作指南与最佳实践。通过图文并茂的教程,助您快速上手,最大化发挥WorkBuddy的办公效能。

2026.04.09

522

19

CodeGeeX下载安装教程合集
CodeGeeX下载安装教程合集

提供CodeGeeX最新版下载地址、历史版本下载、VS Code安装教程、JetBrains安装教程及常见安装问题解决方案。

2026.06.16

456

15

CodeGeeX代码生成教程合集
CodeGeeX代码生成教程合集

汇总CodeGeeX代码生成技巧、代码补全教程、单元测试生成、代码优化及实际开发案例。

2026.06.16

437

31

CodeGeeX大模型教程合集
CodeGeeX大模型教程合集

详细介绍CodeGeeX底层模型能力、多语言代码生成效果、模型架构及应用场景

2026.06.16

116

10

CodeGeeX VSCode插件教程大全
CodeGeeX VSCode插件教程大全

专注CodeGeeX VS Code插件的安装配置、功能使用、快捷键及开发实践。

2026.06.16

510

15

AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

2026.09.16

140

9

ai生成视频的工具免费版合集
ai生成视频的工具免费版合集

本专题汇总了当前免费AI生成视频工具的排行榜与推荐清单,涵盖seko、讯飞智作、AniShort及剧云、Lovart等多模型集成平台。同时整理了各工具的免费额度、输出时长、水印政策及适用场景差异,助您快速选择合适工具开启AI视频创作。

2026.09.16

60

10

Pandas时间序列分析与可视化报表
Pandas时间序列分析与可视化报表

本专题整理Pandas日期转换、时间索引、重采样、滚动窗口、时区处理、plot绘图、Styler表格样式和报表输出方法。

2026.09.16

60

23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程