swagger-api/swagger-codegen

[HTML] Theme for API Documentation

Open

#5,598 opened on May 10, 2017

View on GitHub
 (6 comments) (2 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: HTMLGeneral: Suggestionhelp wanted

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

Contributor guide

Tech stack
htmlcss
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
HTML/CSS basicsUnderstanding of swagger codegen's html2 generator
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Explore the html2 generator template files in the repository (likely under modules/swagger codegen/src/main/resources/html2/). Check if any existing themes are available or if there is a mechanism to add custom CSS. Investigate how Material Design or Bootstrap can be integrated as a theme. Review comments for any additional suggestions or requirements.