Skip to content
This repository was archived by the owner on Oct 27, 2020. It is now read-only.

Commit af4921f

Browse files
committed
updated config as per suggestions in #1
1 parent d60e0e7 commit af4921f

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,19 @@ Link target will be that page's source file on Github or Gitlab or any repo.
2323
{
2424
"plugins": ["edit-link"],
2525
"pluginsConfig": {
26-
"edit-link": {
27-
"base": "https://github.com/USER/REPO/edit/BRANCH/path/to/book",
28-
"label": "Edit This Page"
29-
}
26+
"edit-link": {
27+
"base": "https://github.com/USER/REPO/edit/BRANCH/path/to/book",
28+
"label": "Edit This Page"
29+
}
3030
}
3131
}
3232
```
33-
**Important**: Make sure you edit value of `edit-link => base`. You can replace `edit` with `tree` if you want source file to open in read-mode, rather than edit-mode directly on github/gitlab.
34-
3533
**Note**: Above snippet can be used as complete `book.json` file, if your book doesn't have one yet.
3634

37-
### Step #2 - gitbook commands
35+
**Github/Gitlab**: In string `...REPO/edit/BRANCH...`, you may replace `edit` with `tree` if you want source file to open in read-mode, rather than edit-mode directly on github/gitlab.
36+
37+
38+
### Step #2 - gitbook commands
3839

3940
1. Run `gitbook install`. It will automatically install `edit-link` gitbook plugin for your book. This is needed only once.
4041
2. Build your book (`gitbook build`) or serve (`gitbook serve`) as usual.

0 commit comments

Comments
 (0)