diff --git a/book.json b/book.json index 2f0079640..3fdcbb27b 100644 --- a/book.json +++ b/book.json @@ -1,10 +1,14 @@ { "plugins": [ - "disqus" + "disqus", + "ga" ], "pluginsConfig": { "disqus": { "shortName": "kesenhoo" + }, + "ga": { + "token": "UA-37679268-1" } } } \ No newline at end of file diff --git a/node_modules/gitbook-plugin-ga/.npmignore b/node_modules/gitbook-plugin-ga/.npmignore new file mode 100644 index 000000000..da23d0d4b --- /dev/null +++ b/node_modules/gitbook-plugin-ga/.npmignore @@ -0,0 +1,25 @@ +# Logs +logs +*.log + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +# Deployed apps should consider commenting this line out: +# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git +node_modules diff --git a/node_modules/gitbook-plugin-ga/LICENSE b/node_modules/gitbook-plugin-ga/LICENSE new file mode 100644 index 000000000..ad410e113 --- /dev/null +++ b/node_modules/gitbook-plugin-ga/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/node_modules/gitbook-plugin-ga/README.md b/node_modules/gitbook-plugin-ga/README.md new file mode 100644 index 000000000..f5144f0a9 --- /dev/null +++ b/node_modules/gitbook-plugin-ga/README.md @@ -0,0 +1,48 @@ +Google Analytics tracking for GitBook +============== + +You can use install it via **NPM**: + +``` +$ npm install gitbook-plugin-ga +``` + +And use it for your book with in the book.json: + +``` +{ + "plugins": ["ga"] +} +``` + +You can set the Google Analytics tracking ID using the plugins configuration in the book.json: + +``` +{ + "plugins": ["ga"], + "pluginsConfig": { + "ga": { + "token": "UA-XXXX-Y" + } + } +} +``` + +You can customize the tracker object by passing additional configuration options. You can either pass in `auto`, `none` or an object: + +``` +{ + "plugins": ["ga"], + "pluginsConfig": { + "ga": { + "token": "UA-XXXX-Y", + "configuration": { + "cookieName": "new_cookie_name", + "cookieDomain": "mynew.domain.com" + } + } + } +} +``` + +For an overview of all available configuration parameters, please refer to the [analytics.js field reference](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#create). diff --git a/node_modules/gitbook-plugin-ga/book/plugin.js b/node_modules/gitbook-plugin-ga/book/plugin.js new file mode 100644 index 000000000..c2c39c4d1 --- /dev/null +++ b/node_modules/gitbook-plugin-ga/book/plugin.js @@ -0,0 +1,13 @@ +require(["gitbook"], function(gitbook) { + gitbook.events.bind("start", function(e, config) { + config.ga = config.ga || {}; + }); + + gitbook.events.bind("page.change", function() { + ga('send', 'pageview'); + }); + + gitbook.events.bind("exercise.submit", function(e, data) { + + }); +}); \ No newline at end of file diff --git a/node_modules/gitbook-plugin-ga/index.js b/node_modules/gitbook-plugin-ga/index.js new file mode 100644 index 000000000..6d32c69db --- /dev/null +++ b/node_modules/gitbook-plugin-ga/index.js @@ -0,0 +1,35 @@ +module.exports = { + book: { + assets: "./book", + js: [ + "plugin.js" + ], + html: { + "body:end": function() { + var config = this.options.pluginsConfig.ga || {}; + + if (!config.token) { + throw "Need to option 'token' for Google Analytics plugin"; + } + + if (!config.configuration) { + config.configuration = 'auto'; + } + + if(typeof config.configuration === 'object' && config.configuration !== null) { + configuration = JSON.stringify(config.configuration); + } + else if (['auto', 'none'].indexOf(config.configuration) != -1) { + configuration = "'" + config.configuration + "'"; + } + + return ""; + } + } + } +}; diff --git a/node_modules/gitbook-plugin-ga/package.json b/node_modules/gitbook-plugin-ga/package.json new file mode 100644 index 000000000..5ebd5cce1 --- /dev/null +++ b/node_modules/gitbook-plugin-ga/package.json @@ -0,0 +1,38 @@ +{ + "name": "gitbook-plugin-ga", + "description": "Google Analytics tracking for your gitbook", + "main": "index.js", + "version": "0.2.0", + "engines": { + "gitbook": ">=0.4.6" + }, + "homepage": "https://github.com/GitbookIO/plugin-ga", + "repository": { + "type": "git", + "url": "https://github.com/GitbookIO/plugin-ga.git" + }, + "license": "Apache 2", + "bugs": { + "url": "https://github.com/GitbookIO/plugin-ga/issues" + }, + "_id": "gitbook-plugin-ga@0.2.0", + "dist": { + "shasum": "456ef5daa08103c47cc38628667a1d34098bfd01", + "tarball": "http://registry.npmjs.org/gitbook-plugin-ga/-/gitbook-plugin-ga-0.2.0.tgz" + }, + "_from": "gitbook-plugin-ga@*", + "_npmVersion": "1.4.3", + "_npmUser": { + "name": "samypesse", + "email": "samypesse@gmail.com" + }, + "maintainers": [ + { + "name": "samypesse", + "email": "samypesse@gmail.com" + } + ], + "directories": {}, + "_shasum": "456ef5daa08103c47cc38628667a1d34098bfd01", + "_resolved": "https://registry.npmjs.org/gitbook-plugin-ga/-/gitbook-plugin-ga-0.2.0.tgz" +} diff --git a/package.json b/package.json index 5a42371ce..56fb89df1 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "book", "version": "0.0.0", "dependencies": { - "gitbook-plugin-disqus": "*" + "gitbook-plugin-disqus": "*", + "gitbook-plugin-ga": "*" } } \ No newline at end of file