search

gbif / doc-documentation-guidelines

Guidelines for authoring digital documentation for GBIF
https://docs.gbif.org/documentation-guidelines/en/
Other
0 stars 1 forks source link

Add 'Edit on GitHub' button to HTML version #9

Closed kcopas closed 5 years ago

kcopas commented 5 years ago

The one addition I'd request is a way of linking back from an HTML version to its GitHub repo.

I can create an image, but I think this should be an inviting interactive element, very button-like.

Precedent I have in mind is GitBook's use of something like this: Screenshot 2019-04-23 at 16 49 13

MattBlissett commented 5 years ago

Done, see https://docs.gbif-uat.org/openrefine-guide/1.0/ for example.

Styling is not my strong suit, and can be reviewed with the rest of the overall style (currently 100% the default).

kcopas commented 5 years ago

Actually, that's very nice.

I might opt for 'View source on GitHub' but can easily wrangle—thanks.

MattBlissett commented 5 years ago

You can edit the translations (indeed, someone must add French and Portuguese) in https://github.com/gbif/gbif-asciidoctor-toolkit/tree/master/gbif-extensions/lib/translate-labels

Or, the same attributes can be set in a document to override these defaults.