Skip to content

Commit 08ac952

Browse files
committed
add links in README plus a few edits
1 parent 0e1dc6a commit 08ac952

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

script/bookmarklets/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ Clicking the bookmark will then execute the JavaScript.
1515

1616
## "View in development" toggle
1717

18-
`script/bookmarklets/view-in-development.js`
18+
[`script/bookmarklets/view-in-development.js`](./view-in-development.js)
1919

2020
When you're looking at a page on docs.github.com or a preview server at preview.ghdocs.com, clicking this bookmarklet will load the same path you're viewing but on your local server running at localhost:4000.
2121

2222
## "View in production" toggle
2323

24-
`script/bookmarklets/view-in-production.js`
24+
[`script/bookmarklets/view-in-production.js`](./view-in-production.js)
2525

2626
When you're looking at a page on a preview server at preview.ghdocs.com or your local server running at localhost:4000, clicking this bookmarklet will load the same path you're viewing but on the live documentation site at docs.github.com.
2727

2828
## Open a docs article in VS Code
2929

30-
`script/bookmarklets/open-in-vscode.js`
30+
[`script/bookmarklets/open-in-vscode.js`](./open-in-vscode.js)
3131

3232
When you're looking at a page on either docs.github.com, preview.ghdocs.com, or localhost:400, clicking this bookmarklet will open the source Markdown file from your local checkout in VS Code.
3333

3434
The installation requires a few steps:
3535

36-
1. Copy the contents of `script/bookmarklets/open-in-vscode.js`.
36+
1. Copy the contents of [`script/bookmarklets/open-in-vscode.js`](./open-in-vscode.js).
3737
1. Browse to https://chriszarate.github.io/bookmarkleter/ and paste the code into the box.
3838
1. Find the path of **your local checkout** of the docs repo you want to open files from (for example, `/Users/<USERNAME>/repos/docs`).
3939
1. Paste the path in place of where it says `REPLACE_ME` in line 1 (make sure to leave the single quotes around it).
@@ -42,8 +42,8 @@ The installation requires a few steps:
4242

4343
## Add preview links to PRs
4444

45-
`script/bookmarklets/add-pr-links.js`
45+
[`script/bookmarklets/add-pr-links.js`](./add-pr-links.js)
4646

47-
This bookmarklet modifies the `Files changed` page of a GitHub pull request that has a current staging deployment. For each Markdown file in the diff view, it adds links to the preview deployment of the file for each version: `dotcom / GHEC / GHES / AE`. (Some of these may get you a "page not found" if that version of the page doesn't exist.)
47+
This bookmarklet modifies the `Files changed` page of a GitHub pull request that has a current staging deployment. For each Markdown file in the diff view, it adds links to the preview deployment of the file for each version: `FPT / GHEC / GHES / AE`. (Some of these may redirect to another version or 404 if that version of the page doesn't exist.)
4848

4949
Note: readable JavaScript source lives in `script/bookmarklets/pr-link-source.js`. The bookmarklet code was generated via https://chriszarate.github.io/bookmarkleter.

0 commit comments

Comments
 (0)