Markdown Documentation

Apidog goes beyond API documentation by allowing you to integrate rich Markdown content directly within your documentation. This enables you to create comprehensive user guides that seamlessly combine API references with explanatory text, tutorials, and examples. Markdown documents can be added at multiple levels and displayed alongside API documentation for a complete documentation experience.

Standalone Markdown Documents

Add standalone Markdown documents to any endpoint folder by clicking the plus (+) button. 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

Add Markdown content at the folder level to provide context and overview information. When readers click on a folder name in the documentation, they'll see the folder's Markdown content. Without folder-level Markdown, clicking a folder simply expands it to reveal its contents.

To add folder-level Markdown:

Apidog Markdown Extensions

Apidog Markdown supports a variety of extended styles, including Card, Accordion, Frame, and more. These custom components enable you to create richer and more interactive documentation experiences.

Easily insert these styles through the Markdown editor by clicking the Insert button, which provides a collection of available elements.

Learn More

Learn more about Apidog Markdown.

Markdown Documentation

Standalone Markdown Documents#

Markdown within Endpoints#

Folder-Level Markdown#

Apidog Markdown Extensions#

Standalone Markdown Documents

Markdown within Endpoints

Folder-Level Markdown

Apidog Markdown Extensions