Skip to content

导出到 Markdown

使用方法

方式一:右键导出

  1. 打开项目中包含 API 的文件,或者在 IDEA 左边项目文件区域选择文件或文件夹
  2. 鼠标右键点击文件内容或文件夹
  3. 选择 ExportMarkdown 导出该文件或文件夹中所有的 API

方式二:快捷键导出

  1. 打开项目中包含 API 的文件,或者在 IDEA 左边项目文件区域选择文件或文件夹
  2. 使用快捷键 Alt + Shift + E (Windows/Linux) 或 Ctrl + E (macOS)
  3. 选择要导出的 API,选择导出渠道 Markdown
  4. 点击 ✔ 按钮或按回车键完成导出

Markdown 可用设置

  • outputDemo: 导出 Markdown 文档时,为每个 API 生成一个响应 demo
  • outputCharset: 选择导出 Markdown 文档时使用的字符集,当导出文档出现乱码时可尝试修改此配置

详见 IDE 设置

更多自定义配置

参见 Markdown 模板配置

基于 Apache-2.0 许可发布