pseudomuto / protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers
MIT License
2.61k stars 462 forks source link

Anchors for messages, fields, enums, services #431

Open jacobtolar opened 3 years ago

jacobtolar commented 3 years ago

This adds additional anchor links in the HTML template to make sharing a link to a specific file, message, field, enum value, or service simpler.

Motivation: We have many protobufs with hundreds of fields, it would be nice to be able to link directly to a field rather than only a message.

If it would be preferable, I'd be happy to change this to use an icon or text next to the element rather than making the headers/fields themselves links. E.g.:

I also haven't added this here but could check in a simple CSS change to highlight the item you've navigated to, e.g.:

image

cc @pseudomuto -- I will push the remaining changes (e.g. test fixtures, generated resources, etc) once any discussion on how this should be displayed is resolved.