citation.js icon indicating copy to clipboard operation
citation.js copied to clipboard

Use better JSDoc theme

Open larsgw opened this issue 7 years ago • 0 comments

I changed a few things already in the current theme (Minami):

  • code highlighting theme
  • code font size (mainly in headings)
  • table styling (there weren't even any borders)
  • contrast between methods
  • favicons
  • theme colors

Other features I'd like:

  • a more expansive navigation (i.e. showing sub-tutorials, listing sub-namespaces as such, etc.)
  • in-page navigation
  • proper distinction between doclets
  • a more automated way to add favicons
  • proper layout for windows wider than ~700px
  • proper layout in doclets
  • auto-generated examples
  • more readable method signatures
  • clearer references to related content and tutorials
  • headers that are actually clickable to easily get the page hash to link to

Some other cool, but perhaps unnecessary things:

  • manifest.json
  • Service Workers for offline functionality
  • customisable color schemes (and perhaps fonts etc.)
  • search functionality
  • schema.org integration (the Google CSE results were somewhat disapointing) [EDIT: schema.org probably won't fix that, but perhaps some other schema]

larsgw avatar Dec 29 '17 22:12 larsgw