Explorar o código

add custom plugin

Gogs %!s(int64=6) %!d(string=hai) anos
pai
achega
ae7d45e46a

+ 2 - 2
book.json

@@ -12,7 +12,7 @@
         "theme-comscore",
         "search-pro@^2.0.2",
         "tbfed-pagefooter",
-        "expandable-chapters-small",
+        "expandable-menu",
         "edit-link",
         "anchor-navigation-ex"
     ],
@@ -56,4 +56,4 @@
     "variables": {
         "admin": "张哲 yy:909030220"
     }
-}
+}

+ 7 - 0
custom_plugins/gitbook-plugin-expandable-menu/.project

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>gitbook-plugin-expandable-menu</name>
+	<comment></comment>
+	<projects>
+	</projects>
+</projectDescription>

+ 202 - 0
custom_plugins/gitbook-plugin-expandable-menu/LICENSE

@@ -0,0 +1,202 @@
+                                 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.
+

+ 4 - 0
custom_plugins/gitbook-plugin-expandable-menu/README.md

@@ -0,0 +1,4 @@
+插件源地址: https://github.com/chrisjake/gitbook-plugin-expandable-chapters-small  
+原插件不会在载入页面时展开左侧目录. 经过修改后的插件支持了这一功能  
+
+modify by 张哲 2018/9/11

+ 29 - 0
custom_plugins/gitbook-plugin-expandable-menu/book/expandable-chapters.css

@@ -0,0 +1,29 @@
+.book .book-summary .chapter > .articles {
+	overflow: hidden;
+	max-height: 0px;
+}
+
+.book .book-summary .chapter.expanded > .articles {
+	max-height: 9999px;
+}
+
+.book .book-summary .exc-trigger {
+	position: absolute;
+  	left: 12px;
+  	top: 12px;
+}
+
+.book .book-summary ul.summary li a,
+.book .book-summary ul.summary li span {
+	padding-left: 30px;
+}
+
+.book .book-summary .exc-trigger:before {
+  	content: "\f105";
+}
+
+.book .book-summary .expanded > a .exc-trigger:before,
+.book .book-summary .expanded > span .exc-trigger:before {
+	content: "\f107";
+}
+

+ 78 - 0
custom_plugins/gitbook-plugin-expandable-menu/book/expandable-chapters.js

@@ -0,0 +1,78 @@
+require(['gitbook', 'jQuery'], function(gitbook, $) {
+  var TOGGLE_CLASSNAME = 'expanded',
+      CHAPTER = '.chapter',
+      ARTICLES = '.articles',
+      TRIGGER_TEMPLATE = '<i class="exc-trigger fa"></i>',
+      LS_NAMESPACE = 'expChapters';
+  var init = function () {
+    // adding the trigger element to each ARTICLES parent and binding the event
+    $(ARTICLES)
+      .parent(CHAPTER)
+      .children('a, span')
+      .append(
+        $(TRIGGER_TEMPLATE)
+          .on('click', function(e) {
+            e.preventDefault();
+            e.stopPropagation();
+            toggle($(e.target).closest(CHAPTER));
+          })
+      );
+    // hacky solution to make spans be clickable when used in combination with "ungrey" plugin
+    $(CHAPTER + ' > span')
+      .on('click', function(e) {
+            e.preventDefault();
+            e.stopPropagation();
+            toggle($(e.target).closest(CHAPTER));
+        });
+    expand(lsItem());
+    //expand current selected chapter with it's parents
+    var activeChapter = $(CHAPTER + '.active');
+    expand(activeChapter);
+    expand(activeChapter.parents(CHAPTER));
+
+
+  } 
+  var toggle = function ($chapter) {
+    if ($chapter.hasClass('expanded')) {
+      collapse($chapter);
+    } else {
+      expand($chapter);
+    }
+  }
+  var collapse = function ($chapter) {
+    if ($chapter.length && $chapter.hasClass(TOGGLE_CLASSNAME)) {
+      $chapter.removeClass(TOGGLE_CLASSNAME);
+      lsItem($chapter);
+    }
+  }
+  var expand = function ($chapter) {
+    if ($chapter.length && !$chapter.hasClass(TOGGLE_CLASSNAME)) {
+      $chapter.addClass(TOGGLE_CLASSNAME);
+      lsItem($chapter);
+    }
+  }
+  var lsItem = function () {
+    var map = JSON.parse(localStorage.getItem(LS_NAMESPACE)) || {}
+    if (arguments.length) {
+      var $chapters = arguments[0];
+      $chapters.each(function (index, element) {
+        var level = $(this).data('level');
+        var value = $(this).hasClass(TOGGLE_CLASSNAME);
+        map[level] = value;
+      })
+      localStorage.setItem(LS_NAMESPACE, JSON.stringify(map));
+    } else {
+      return $(CHAPTER).map(function(index, element){
+        if (map[$(this).data('level')]) {
+          return this;
+        }
+      })
+    }
+  }
+  gitbook.events.bind('start', function() {
+    init()
+  }); 
+  gitbook.events.bind('page.change', function() {
+    init()
+  }); 
+});

+ 12 - 0
custom_plugins/gitbook-plugin-expandable-menu/index.js

@@ -0,0 +1,12 @@
+module.exports = {
+    // Extend website resources and html
+    website: {
+        assets: "./book",
+        js: [
+            "expandable-chapters.js"
+        ],
+        css: [
+            "expandable-chapters.css"
+        ]
+    }
+};

+ 5 - 0
custom_plugins/gitbook-plugin-expandable-menu/package-lock.json

@@ -0,0 +1,5 @@
+{
+  "name": "gitbook-plugin-expandable-menu",
+  "version": "0.1.7",
+  "lockfileVersion": 1
+}

+ 9 - 0
custom_plugins/gitbook-plugin-expandable-menu/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "gitbook-plugin-expandable-menu",
+  "description": "Expandable chapters for convenient navigation within a gitbook",
+  "main": "index.js",
+  "version": "0.1.7",
+  "engines": {
+    "gitbook": ">=0.4.6"
+  }
+}