O Apidog vai além da documentação de API ao permitir que você integre conteúdo Markdown enriquecido diretamente na sua documentação. Isto permite-lhe criar guias de utilizador abrangentes que combinam perfeitamente referências de API com texto explicativo, tutoriais e exemplos. Os documentos Markdown podem ser adicionados em vários níveis e apresentados juntamente com a documentação de API para uma experiência de documentação completa.
Adicione documentos Markdown autónomos a qualquer pasta de endpoints clicando no botão de mais (+). Escreva conteúdo Markdown no editor e pré-visualize instantaneamente o resultado renderizado no painel do lado direito.
O Markdown também é suportado no campo Descrição de cada endpoint. Qualquer Markdown que você adicionar aqui será renderizado como texto formatado na documentação de API, tornando as descrições dos seus endpoints claras e visualmente apelativas.
Adicione conteúdo Markdown ao nível da pasta para fornecer contexto e informações gerais. Quando os leitores clicarem no nome de uma pasta na documentação, verão o conteúdo Markdown da pasta. Sem Markdown ao nível da pasta, clicar numa pasta simplesmente expande-a para revelar o seu conteúdo.Para adicionar Markdown ao nível da pasta:
O Markdown do Apidog suporta uma variedade de estilos alargados, incluindo Card, Accordion, Frame e muito mais. Estes componentes personalizados permitem-lhe criar experiências de documentação mais ricas e interativas.Insira facilmente estes estilos através do editor Markdown clicando no botão Insert, que disponibiliza uma coleção de elementos disponíveis.