Sobre Slate Api Docs Generator

Slate - bela documentação estática para sua API. Características 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 por Stripe's e Paypal's API docs. Slate é responsivo, por isso parece ótimo em tablets, telefones e até mesmo na impressão. Tudo em uma única página — Foram os dias em que seus usuários tiveram que procurar por um milhão de páginas para encontrar o que eles queriam. Slate coloca toda a documentação em uma única página. No entanto, temos & #39; não sacrificamos a vinculabilidade. Como você rolar, seu navegador & #39;s hash vai atualizar para o cabeçalho mais próximo, então ligar para um ponto particular na documentação ainda é natural e fácil. Slate é apenas Markdown — Quando você escreve documentos com Slate, você're apenas escrevendo Markdown, o que torna simples editar e entender. Tudo está escrito em Markdown — mesmo as amostras de código são apenas blocos de código Markdown. Escrever amostras de código em vários idiomas — Se sua API tiver ligações em várias linguagens de programação, você pode facilmente colocar em guias para alternar entre eles. No seu documento, você & #39; vai distinguir diferentes idiomas especificando o nome da linguagem na parte superior de cada bloco de código, assim como com Github Flavored Markdown. Sintaxe fora da caixa destacando para quase 60 idiomas, nenhuma configuração necessária. Tabela de rolagem automática e suave dos conteúdos na extrema esquerda da página. Como você rolar, ele exibe sua posição atual no documento. It's fast, too. We're usando Slate no TripIt para criar documentação para nossa nova API, onde nossa tabela de conteúdos tem mais de 180 entradas. We' ter certeza de que o desempenho permanece excelente, mesmo para documentos maiores.

Categorias

  • Free
  • Open Source
  • Paid
  • Development

Alternativas para Slate Api Docs Generator

Natural Docs

Natural Docs

grátis proprietário
Natural Docs é um gerador de documentação de código aberto para várias linguagens de programação. Você documenta seu cód... ver detalhes
Não disponível

Javadoc

grátis proprietário
Javadoc é uma ferramenta do Sun Microsystems para gerar documentação de API em formato HTML a partir de comentários doc ...
Document! X

Document! X

pago proprietário
Documento! X é uma combinação de uma ferramenta de documentação automatizada e um ambiente de criação completa que pode ... ver detalhes
Developerhub

Developerhub

pago proprietário
Criar documentação bonita poderosa, sem complicações. Desenvolvedor Hub está hospedado serviço de portais de documentaçã... ver detalhes
Não disponível

Ldoc

grátis código aberto
LDoc é <a href='/alternativeto.net/software/lua/'> Lua</um gerador de documentação destinado a ser compatível com <a hre...
Swagger.io

Swagger.io

grátis código aberto
Swagger é uma ferramenta de documentação de fonte aberta RESTapi... ver detalhes
Daux.io

Daux.io

grátis código aberto
Daux.io é um gerador de documentação que usa uma estrutura de pasta simples e arquivos Markdown para criar documentação ... ver detalhes
Docsie

Docsie

compras integradas proprietário
Docsie é um software de colaboração para documentos de software, intranets e gerenciamento de conhecimento. Crie facilme... ver detalhes
Não disponível

Wikitten

grátis código aberto
Wikitten é um pequeno, rápido, PHP wiki que eu fiz porque eu realmente precisava de um lugar para armazenar minhas notas...
Readme

Readme

pago proprietário
ReadMe é um lugar completamente personalizável e colaborativo para API dinâmica e / ou documentação do produto. Os usuár... ver detalhes
Docma

Docma

grátis código aberto
Docma é uma ferramenta poderosa para gerar facilmente bela documentação HTML de arquivos Javascript (JSDoc), Markdown e ... ver detalhes
Não disponível

Codex

grátis código aberto
Codex é uma simples plataforma de documentação baseada em arquivos Markdown construída em cima de Laravel. It&#39;s comp...
Apigen

Apigen

grátis código aberto
ApiGen é a ferramenta para criar documentação profissional de API do código fonte PHP, semelhante a <a href='/alternativ... ver detalhes
Sandcastle

Sandcastle

grátis código aberto
A Sandcastle produz um estilo MSDN preciso, documentação abrangente, refletindo sobre os conjuntos de origem e integrand... ver detalhes
Aglio

Aglio

grátis código aberto
aglio - Um renderizador API Blueprint que suporta vários temas e saídas HTML estático que pode ser servido por qualquer ... ver detalhes