├── .gitignore ├── LICENSE ├── README.md ├── book └── plugin.js ├── index.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # Compiled binary addons (http://nodejs.org/api/addons.html) 20 | build/Release 21 | 22 | # Dependency directory 23 | # Deployed apps should consider commenting this line out: 24 | # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git 25 | node_modules 26 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | GitBook Plugin: Edit Link 2 | ====================================== 3 | 4 | This GitBook Plugin adds "Edit This Page" link on every page. 5 | 6 | Link target will be that page's source file on Github or Gitlab or any repo. 7 | 8 | ## Screenshot 9 | 10 | ![gitbook-plugin-edit-link](https://cloud.githubusercontent.com/assets/4115/5695161/f5b79002-99b8-11e4-821a-d2af6c729348.png) 11 | 12 | ## Usage 13 | 14 | ### Step #1 - Update `book.json` file 15 | 16 | 1. In you gitbook's `book.json` file, add `edit-link` to `plugins` list. 17 | 2. In `pluginsConfig`, Set `base` value which is base path to your github or gitlab or other code repo. Trailing slash is NOT required. 18 | 3. By default link label will be "Edit This Page". You can change it using plugin config `label`. 19 | 20 | #### Sample `book.json` file for gitbook version 2.0.1 and above 21 | 22 | ``` 23 | { 24 | "gitbook": "2.0.1", 25 | "plugins": ["edit-link"], 26 | "pluginsConfig": { 27 | "edit-link": { 28 | "base": "https://github.com/USER/REPO/edit/BRANCH/path/to/book", 29 | "label": "Edit This Page" 30 | } 31 | } 32 | } 33 | ``` 34 | 35 | #### Sample `book.json` file for gitbook version 2.0.1+ and multilingual labels 36 | 37 | ``` 38 | { 39 | "gitbook": "2.0.1", 40 | "plugins": ["edit-link"], 41 | "pluginsConfig": { 42 | "edit-link": { 43 | "base": "https://github.com/USER/REPO/edit/BRANCH/path/to/book", 44 | "label": { 45 | "en": "Edit This Page", 46 | "de": "Seite bearbeiten" 47 | } 48 | } 49 | } 50 | } 51 | ``` 52 | 53 | #### Sample `book.json` file for older gitbook versions <= 1.5.0 54 | 55 | ``` 56 | { 57 | "gitbook": "1.5.0", 58 | "plugins": ["edit-link@1.1.0"], 59 | "pluginsConfig": { 60 | "edit-link": { 61 | "base": "https://github.com/USER/REPO/edit/BRANCH/path/to/book", 62 | "label": "Edit This Page" 63 | } 64 | } 65 | } 66 | ``` 67 | 68 | **Note**: Above snippet can be used as complete `book.json` file, if your book doesn't have one yet. 69 | 70 | **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. 71 | 72 | ### Step #2 - gitbook commands 73 | 74 | 1. Run `gitbook install`. It will automatically install `edit-link` gitbook plugin for your book. This is needed only once. 75 | 2. Build your book (`gitbook build`) or serve (`gitbook serve`) as usual. 76 | 77 | ## Troubleshooting 78 | 79 | 1. If you are not seeing the "Edit this page" link, check if your `book.json` is valid. You can use this online tool - [http://json.parser.online.fr/beta/](http://json.parser.online.fr/beta/) 80 | 2. Check if you are using default gitbook theme. It is NOT recommended to modify gitbook themes directly. 81 | 82 | ## Known Issue 83 | 84 | Gitbook 2.0.1 has removed `page:after` hook which this plugin needs. An issue has been reported here - https://github.com/GitbookIO/gitbook/issues/724 but meanwhile this plugin is using workaround added by this pull request - https://github.com/rtCamp/gitbook-plugin-edit-link/pull/4 85 | 86 | So when using Gitbook 2.0.1, you may see following warning in console at the time of running build: 87 | 88 | > warn: hook 'page' used by plugin 'gitbook-plugin-edit-link' is deprecated, and will be remove in the coming versions 89 | 90 | You can safely ignore above warning for now. 91 | 92 | ## How this work? 93 | 94 | This plugin simply looks for HTML comment `` in parsed page content and insert "edit link" HTML just before ``. 95 | 96 | This means if that HTML comment changes, this plugin will break but I hope to fix it easily whenever that happen. 97 | 98 | ## Changelog 99 | 100 | **1.3 - 28 April 2015** 101 | 102 | - Gitbook 2.0.1 compatibility added by [@todvora](https://github.com/rtCamp/gitbook-plugin-edit-link/pull/4). Please see known-issues for more details. 103 | 104 | **1.2 - 03 April 2015** 105 | 106 | - Multiligual gitbook support added by [@aniav](https://github.com/aniav) ([#2](https://github.com/rtCamp/gitbook-plugin-edit-link/pull/2)) 107 | 108 | **1.1.3 - 11 Jan 2015** 109 | 110 | - Initial release 111 | 112 | ## Does this interest you? 113 | 114 | Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions 115 | -------------------------------------------------------------------------------- /book/plugin.js: -------------------------------------------------------------------------------- 1 | require(["gitbook", "jQuery"], function(gitbook, $) { 2 | gitbook.events.bind('start', function (e, config) { 3 | var conf = config['edit-link']; 4 | var label = conf.label; 5 | var base = conf.base; 6 | var lang = gitbook.state.innerLanguage; 7 | if (lang) { 8 | // label can be a unique string for multi-languages site 9 | if (typeof label === 'object') label = label[lang]; 10 | 11 | lang = lang + '/'; 12 | } 13 | 14 | // Add slash at the end if not present 15 | if (base.slice(-1) != "/") { 16 | base = base + "/"; 17 | } 18 | 19 | gitbook.toolbar.createButton({ 20 | icon: 'fa fa-edit', 21 | text: label, 22 | onClick: function() { 23 | var filepath = gitbook.state.filepath; 24 | 25 | window.open(base + lang + filepath); 26 | } 27 | }); 28 | }); 29 | 30 | }); -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var path = require('path'); 2 | 3 | module.exports = { 4 | book: { 5 | assets: "./book", 6 | js: ["plugin.js"] 7 | } 8 | }; 9 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gitbook-plugin-edit-link", 3 | "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.", 4 | "main": "index.js", 5 | "version": "2.0.2", 6 | "author": "rtCamp ", 7 | "contributors": [ 8 | { 9 | "name": "Rahul Bansal", 10 | "email": "rahul.bansal@rtcamp.com" 11 | }, 12 | { 13 | "name": "Samy Pessé", 14 | "email": "samy@gitbook.com" 15 | } 16 | ], 17 | "engines": { 18 | "gitbook": ">=2.5.0" 19 | }, 20 | "homepage": "https://github.com/rtCamp/gitbook-plugin-edit-link", 21 | "repository": { 22 | "type": "git", 23 | "url": "https://github.com/rtCamp/gitbook-plugin-edit-link.git" 24 | }, 25 | "license": "Apache-2.0", 26 | "bugs": { 27 | "url": "https://github.com/rtCamp/gitbook-plugin-edit-link/issues" 28 | }, 29 | "keywords": [ 30 | "gitbook", 31 | "plugin", 32 | "edit-with", 33 | "github" 34 | ], 35 | "gitbook": { 36 | "properties": { 37 | "base": { 38 | "type": "string", 39 | "title": "Base for the edit redirection", 40 | "required": true 41 | }, 42 | "label": { 43 | "type": [ "string", "object" ], 44 | "title": "Label for the edit button", 45 | "default": "Edit This Page" 46 | } 47 | } 48 | } 49 | } 50 | --------------------------------------------------------------------------------