123
Slate API Docs Generator

Slate API Docs Generator

Slate - documentação estática bonita para sua API.
Slate - documentação estática bonita para sua API.Recursos Design limpo e intuitivo - Com o Slate, a descrição da sua API está no lado esquerdo da sua documentação, e todos os exemplos de código estão no lado direito.Inspirado nos documentos de API do Stripe e do Paypal.O Slate é responsivo, por isso fica ótimo em tablets, telefones e até na impressão.Tudo em uma única página - Longe vão os dias em que seus usuários precisavam pesquisar um milhão de páginas para encontrar o que queriam.O Slate coloca toda a documentação em uma única página.Nós não sacrificamos o linkability, no entanto.À medida que você rola, o hash do navegador é atualizado para o cabeçalho mais próximo, portanto, vincular a um ponto específico da documentação ainda é natural e fácil.Slate é apenas Markdown - Quando você escreve documentos com o Slate, está escrevendo Markdown, o que facilita a edição e a compreensão.Tudo está escrito no Markdown - mesmo os exemplos de código são apenas blocos de código do Markdown.Escreva exemplos de código em vários idiomas - Se a sua API tiver ligações em vários idiomas de programação, você poderá inserir guias facilmente para alternar entre eles.No seu documento, você distinguirá idiomas diferentes especificando o nome do idioma na parte superior de cada bloco de código, assim como no Github Flavored Markdown.Destaque de sintaxe pronto para uso em quase 60 idiomas, sem configuração necessária.Índice automático e rolagem suave na extremidade esquerda da página.À medida que você rola, ele exibe sua posição atual no documento.Também é rápido.Estamos usando o Slate no TripIt para criar documentação para nossa nova API, onde nosso índice possui mais de 180 entradas.Garantimos que o desempenho permaneça excelente, mesmo para documentos maiores.

Local na rede Internet:

Categorias

Alternativas ao Slate API Docs Generator para Self-Hosted com licença gratuita