racket/scribble

Add "Edit Online" button

Offen

#76 geöffnet am 23.01.2017

 (11 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Racket (102 Forks)github user discovery
help wanted

Repository-Metriken

Stars
 (250 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 12h 51m) (1 gemergte PR in 30 T)

Beschreibung

Goal: pages on docs.racket-lang.org should have a button labeled "Edit on GitHub" that opens the scribble file that generated the HTML file that's displaying the button.

This is an issue and not a PR because I'm not sure how to implement it.

Idea 1 (the dream) change Scribble to automatically add "edit on github" links to the drop-down that appears when you click headings (just below "link to this section"). Guess this would only work for cloned packages.

Idea 2 (the less-wild dream) implement a --github <url> flag for the scribble command that uses the given url to generate the "edit on github" links for every page title / section.

Idea 3 (the easy-to-hack) put an @github-link[url] function in a scriblib library. Documentation authors need to explicitly call this function to put a button on their pages. (Instead of a button, maybe add a keyword to @section or @title)

Contributor Guide