swagger-api/swagger-codegen

[HTML] Theme for API Documentation

Open

#5598 aperta il 10 mag 2017

Vedi su GitHub
 (6 commenti) (2 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Client: HTMLGeneral: Suggestionhelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina i template del generatore html2 e comprendi come è strutturata la documentazione corrente. Ricerca come integrare un framework CSS come Material Design o Bootstrap nell'output generato modificando i template Mustache.
Tech stack
html
Dominio
frontenddocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitHTML
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70