Apidog va más allá de la documentación de API al permitirle integrar contenido enriquecido de Markdown directamente en su documentación. Esto le permite crear guías de usuario completas que combinan sin problemas referencias de API con texto explicativo, tutoriales y ejemplos. Los documentos Markdown pueden añadirse en varios niveles y mostrarse junto con la documentación de API para ofrecer una experiencia de documentación completa.
Añada documentos Markdown independientes a cualquier carpeta de endpoints haciendo clic en el botón más (+). Escriba contenido Markdown en el editor y obtenga una vista previa instantánea del resultado renderizado en el panel del lado derecho.
Markdown también es compatible con el campo Descripción de cada endpoint. Cualquier Markdown que añada aquí se renderizará como texto con formato en la documentación de API, lo que hará que las descripciones de sus endpoints sean claras y visualmente atractivas.
Añada contenido Markdown a nivel de carpeta para proporcionar contexto e información general. Cuando los lectores hagan clic en el nombre de una carpeta en la documentación, verán el contenido Markdown de la carpeta. Sin Markdown a nivel de carpeta, hacer clic en una carpeta simplemente la expande para mostrar su contenido.Para añadir Markdown a nivel de carpeta:
Apidog Markdown admite una variedad de estilos extendidos, incluidos Card, Accordion, Frame y otros. Estos componentes personalizados le permiten crear experiencias de documentación más completas e interactivas.Inserte fácilmente estos estilos mediante el editor de Markdown haciendo clic en el botón Insert, que proporciona una colección de elementos disponibles.