Skip to content

Commit

Permalink
Update docs generators to include proper edit on github links (ghostt…
Browse files Browse the repository at this point in the history
…y-org#3651)

Ref: ghostty-org/website#197

The "Edit on Github" links currently on
[ghostty.org](https://ghostty.org/) link to the downstream MDX files.
This has lead to multiple folks editing the downstream MDX files.

Preview:

https://website-git-edit-on-github-link-override-ghostty.vercel.app/docs/config/reference#auto-update-channel
  • Loading branch information
mitchellh authored Dec 28, 2024
2 parents 1fa2e69 + 16e4529 commit 6cbd69d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/build/webgen/main_actions.zig
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ pub fn genKeybindActions(writer: anytype) !void {
\\---
\\title: Keybinding Action Reference
\\description: Reference of all Ghostty keybinding actions.
\\editOnGithubLink: https://github.com/ghostty-org/ghostty/edit/main/src/input/Binding.zig
\\---
\\
\\This is a reference of all Ghostty keybinding actions.
Expand Down
1 change: 1 addition & 0 deletions src/build/webgen/main_config.zig
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ pub fn genConfig(writer: anytype) !void {
\\---
\\title: Reference
\\description: Reference of all Ghostty configuration options.
\\editOnGithubLink: https://github.com/ghostty-org/ghostty/edit/main/src/config/Config.zig
\\---
\\
\\This is a reference of all Ghostty configuration options. These
Expand Down

0 comments on commit 6cbd69d

Please sign in to comment.