Apidog Markdown
  • Welcome to Apidog Markdown
  • Basic Syntax and Features
  • Components
  • Other Questions
logoPowered by Apidog

Welcome to Apidog Markdown

The Disadvantage of Native Markdown Syntax

Native Markdown syntax is the preferred format for writing technical content among developers. However, its support for more specialized endpoint documentation is somewhat lacking. Many users have to rely on simple table syntax to fill in various input parameters for endpoints and use code blocks to present request/response results.

We believe there is significant space for improvement.

What is Apidog Markdown?

Based on Apidog's excellent support for endpoints documentation, more and more developers are choosing Apidog as their team's technical documentation writing platform.

Continuously providing developers with a smooth writing and visual experience has always been Apidog's goal. After much consideration and refinement of API documentation, we are pleased to launch Apidog Markdown Syntax.

Building on the native Markdown syntax, Apidog Markdown Syntax adds a wide range of easy-to-use component libraries. All built-in elements come with well-organized and designed styles.

Apidog Advanced Styles

It allows you to focus more on content creation itself, without worrying about how to design aesthetically pleasing layouts. Simply input a few simple syntaxes, and you can create visually appealing technical content effortlessly.

Feature Highlights

  1. Easy to Get Started: Apidog Markdown Syntax is simple, easy to learn and use. Combined with an online editor that supports visual insertion of advanced functional components, makes it user-friendly.
  2. High Readability: The component library within Apidog Markdown Syntax is written in plain code text, eliminating the need for complex CSS layout and style syntax, making the documentation more readable.
  3. Rich Formatting: Markdown documents written in Apidog can be easily converted to other formats such as HTML and PDF, making it convenient to view on different devices and platforms.
  4. Aesthetic Styles: The built-in syntax components like buttons, sequence diagrams, and highlight blocks for tips are all meticulously designed for a beautiful and cohesive look.
  5. Wide Compatibility: In Apidog, users can directly export API documentation in Markdown format, import and edit Markdown files from other platforms, seamlessly integrating the documentation with the API development process.
  6. Hight Customizability: After editing the Markdown content, authors can easily publish the content on the internet and share it with others. They can also customize document domains and brand logos, and adjust theme colors for personalization.

:::tip
Apidog Markdown Syntax is designed to be used with Apidog's built-in online API document editor.
:::

Quick Start

[Register/Log in to Apidog](https://apidog.com/) Import a Markdown file into a project within Apidog, or create a new project → Add a Markdown file in the root directory. After entering the project, click on the Markdown file in the left-hand directory. You will then see a visual editing box, with code content on the left and a text preview on the right. The top bar contains convenient visual content components; you can either use code to directly call styles or manually click to insert components. For completed documents, the author can also click the "Share Docs" button on the left to generate a link and publish it on the internet, making it easy to share with other team members or clients for review and facilitating efficient collaboration.
Last modified: 8 months ago