swagger-api / swagger-api/swagger-codegen
[HTML] Theme for API Documentation
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the html2 generator and its generated documentation templates, then review how themes could be applied using Bootstrap or another supported theme system. Done means html2 documentation has an easily selectable, customizable visual theme without disrupting existing generated output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bootstrap, html
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100