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

Commit ba7555a

Browse files
committed
updated readme
1 parent eecfa7c commit ba7555a

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,6 @@ Above snippet can be used as complete `book.json` file, if your book doesn't hav
3939

4040
## How this work?
4141

42-
This plugin simply looks for HTML comment `<!-- Actions Right -->` in parsed page content and insert HTML will be that page's source file on Github or Gitlab or any repo.
42+
This plugin simply looks for HTML comment `<!-- Actions Right -->` in parsed page content and insert "edit link" HTML right after it (HTML comment).
43+
44+
This means if that HTML comment changes, this plugin will break (I hope to fix it easily whenever that happen).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "gitbook-plugin-edit-link",
33
"description": "GitBook Plugin to add \"Edit this page\" link on every page. Link target will be that page's source file on Github or Gitlab or any repo.",
44
"main": "index.js",
5-
"version": "1.1.0",
5+
"version": "1.1.1",
66
"author": "rtCamp <[email protected]>",
77
"contributors": [{
88
"name": "Rahul Bansal",

0 commit comments

Comments
 (0)