Skip to content

Export to Markdown

Usage

Method 1: Right-Click Export

  1. Open a file containing APIs in your project, or select files/folders in the IDEA project panel
  2. Right-click on the file content or folder
  3. Select ExportMarkdown to export all APIs in the file or folder

Method 2: Shortcut Export

  1. Open a file containing APIs in your project, or select files/folders in the IDEA project panel
  2. Use shortcut Alt + Shift + E (Windows/Linux) or Ctrl + E (macOS)
  3. Select the APIs to export, choose Markdown as the export channel
  4. Click the ✔ button or press Enter to complete the export

Markdown Settings

  • outputDemo: Generate a response demo for each API when exporting Markdown
  • outputCharset: Select the character set for Markdown export. Try changing this if exported documents show garbled text

See IDE Settings for more details.

More Customization

See Markdown Template Settings.

Released under the Apache-2.0 License.