racket/scribble

Add "Edit Online" button

开放

#76 创建于 2017年1月23日

 (11 条评论) (2 个反应) (0 位负责人)Racket (102 个派生)github user discovery
help wanted

仓库指标

星标
 (250 个星标)
PR 合并指标
 (平均合并 12小时 51分钟) (30 天内合并 1 个 PR)

描述

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)

贡献者指南