Apidog offers more than just API documentation; you can also integrate Markdown content directly within your documentation. Markdown documents can be combined and displayed alongside API documentation seamlessly.Standalone Markdown Files#
You can add a standalone Markdown document to any endpoint folder by clicking the plus (+) button. After that, you'll be able to write Markdown content in the editor and instantly preview the rendered result in the right-side pane.Markdown within Endpoints#
Markdown is also supported in the Description field of each endpoint. Any Markdown you add here will be rendered as formatted text in the API documentation, making your endpoint descriptions clear and visually appealing.Folder-Level Markdown#
Apidog also allows you to add Markdown content at the Folder level. When you set this up, readers will see the Folder's Markdown content when they click on the Folder name in the documentation. If you don't add Folder-level Markdown, clicking the Folder name will simply expand the folder to reveal its contents.To add Folder-level Markdown, click on the endpoint folder's name in Apidog, navigate to the "Documentation" tab, and then add your Markdown content there.Apidog Markdown Extensions#
Apidog Markdown supports a variety of extended styles, such as Card, Accordion, Frame, and more. These custom components allow you to create richer and more interactive documentation experiences.You can easily insert these styles through the Markdown editor by clicking on the "Insert" button, which provides a collection of available elements to choose from. Modified atΒ 2025-07-09 10:48:43
