swagger-api/swagger-codegen

[HTML] Theme for API Documentation

Open

#5.598 aberto em 10 de mai. de 2017

Ver no GitHub
 (6 comments) (2 reactions) (0 assignees)HTML (5.474 forks)batch import
Client: HTMLGeneral: Suggestionhelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Description

I think it would be a good idea if developers can customize the look and feel of the auto-generated documentation easily by applying different themes. One way is to leverage Google Material Design or Twitter Bootstrap themes as both have a very mature ecosystem (e.g. free, paid themes, web designers who are familiar with these frameworks)

I suggest we start with documentations generated by the html2 generator.

cc @jhitchcock

Guia do colaborador

Direção de pesquisa
Examine os modelos do gerador html2 e entenda como a documentação atual está estruturada. Pesquise como integrar um framework CSS como Material Design ou Bootstrap na saída gerada modificando os modelos Mustache.
Pilha de tecnologia
html
Domain
frontenddocumentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitHTML
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70