swagger-api/swagger-codegen

[HTML] Theme for API Documentation

Ouverte

#5 598 ouverte le 10 mai 2017

Voir sur GitHubGuide contributeur
 (6 commentaires) (2 réactions) (0 personne assignée)HTML (5 474 forks)batch import
Client: HTMLGeneral: Suggestionhelp wanted

Métriques du dépôt

Stars
 (12 701 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez les modèles du générateur html2 et comprenez comment la documentation actuelle est structurée. Recherchez comment intégrer un framework CSS comme Material Design ou Bootstrap dans le résultat généré en modifiant les modèles Mustache.
Stack technique
html
Domaine
frontenddocumentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitHTML
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70