The following usages are supported:

  1. Open the file containing the API in the project or select the file or folder in the project file area on the left-hand side of IntelliJ IDEA. Use the shortcut Alt + Shift + E (Windows) or Ctrl + E (Mac) to open the export dialog. Select the APIs you want to export and choose Markdown as the export format. Finally, click the [✔] button or press Enter to confirm the export.

  2. Open the file containing the API in the project or select the file or folder in the project file area on the left-hand side of IntelliJ IDEA. Right-click on the file editor or folder, and from the context menu, choose EasyApi -> ExportMarkdown.


Markdown available settings :

  • outputDemo: Generate a response demo for each API in the markdown document.
  • outputCharset: Choose the character encoding for the exported 'markdown' document. If the exported document appears garbled, please try adjusting this configuration.