codegeex可自动生成规范markdown文档骨架、readme及表格。需在vscode安装插件并登录,按提示输入指令触发生成,严格校验标题层级、空行分隔、表格对齐语法及项目上下文准确性。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要为新项目快速产出结构清晰、层级规范的 Markdown 技术文档,避免手动敲写标题层级、遗漏关键模块或缩进错位导致渲染异常。
自动生成标准文档骨架
1、在 VSCode 中新建空白 .md 文件,确保已安装并启用 CodeGeeX 官方插件,且登录状态有效。
2、输入提示词:“生成一份关于‘微服务网关设计规范’的技术文档 Markdown 骨架,含一级标题、二级功能模块标题、三级要点说明占位符”,注意末尾不加句号。
3、按下 Ctrl+Enter(Windows/Linux)或 Cmd+Enter(macOS)触发生成;【若未响应,请确认光标位于空行且无选中文本】
4、检查输出:所有标题必须以正确数量的 # 开头(如 ## 接口路由策略),# 后紧跟一个空格;任意两个标题之间必须有空行分隔。
一键生成 README.md 项目文档
方法一:VS Code 插件直连项目上下文
1、在 VSCode 中打开代码项目根目录,确保目录下存在 package.json、requirements.txt 或 pyproject.toml 等标志性配置文件。
2、按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS),输入 “CodeGeeX: Generate README”,回车执行。
3、等待插件分析完成——它会读取源码入口函数、依赖声明和注释块,不是简单关键词匹配。
4、生成的 README.md 将自动在编辑器中打开;【务必核对“使用示例”章节中的命令是否与你实际的启动脚本一致,例如 python main.py 而非 npm start】
文档转 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 预览时全部左对齐,无法实现居中或右对齐效果。
第四步:若需调整某列对齐方式,直接修改对应分隔符:左对齐用 :--,居中用 :-:,右对齐用 --:。









