feat: introduce a text compress for search function

docs/plugins.md

@@ -9,6 +9,8 @@ By default, the hyperlink on the current page is recognized and the content is s
 <script>
   window.$docsify = {
     search: 'auto', // default
+    // Enable text compression to reduce the size, especially if your contents are very large.
+    largeContent: false, // default
 
     search: [
       '/',            // => /README.md

package.json

@@ -36,6 +36,7 @@
     "*.js": "eslint --fix"
   },
   "dependencies": {
+    "lz-string": "^1.5.0",
     "medium-zoom": "^1.1.0",
     "opencollective-postinstall": "^2.0.2",
     "prismjs": "^1.29.0",

src/plugins/search/index.js

@@ -14,6 +14,7 @@ const CONFIG = {
   namespace: undefined,
   pathNamespaces: undefined,
   keyBindings: ['/', 'meta+k', 'ctrl+k'],
+  largeContent: false,
 };
 
 const install = function (hook, vm) {
@@ -33,6 +34,7 @@ const install = function (hook, vm) {
     CONFIG.namespace = opts.namespace || CONFIG.namespace;
     CONFIG.pathNamespaces = opts.pathNamespaces || CONFIG.pathNamespaces;
     CONFIG.keyBindings = opts.keyBindings || CONFIG.keyBindings;
+    CONFIG.largeContent = opts.largeContent || CONFIG.largeContent;
   }
 
   const isAuto = CONFIG.paths === 'auto';

src/plugins/search/search.js

@@ -3,6 +3,8 @@ import {
   getAndRemoveDocisfyIgnoreConfig,
 } from '../../core/render/utils.js';
 
+import LZString from 'lz-string';
+
 let INDEXS = {};
 
 const LOCAL_STORAGE = {
@@ -73,9 +75,25 @@ function getListData(token) {
   return token.text;
 }
 
-function saveData(maxAge, expireKey, indexKey) {
+function saveData(maxAge, expireKey, indexKey, largeContent) {
   localStorage.setItem(expireKey, Date.now() + maxAge);
-  localStorage.setItem(indexKey, JSON.stringify(INDEXS));
+
+  if (largeContent) {
+    const compressed = LZString.compressToUTF16(JSON.stringify(INDEXS));
+    localStorage.setItem(indexKey, compressed);
+  } else {
+    localStorage.setItem(indexKey, JSON.stringify(INDEXS));
+  }
+}
+
+function getData(indexKey, largeContent) {
+  if (largeContent) {
+    const compressedData = localStorage.getItem(indexKey);
+    return (
+      compressedData && JSON.parse(LZString.decompressFromUTF16(compressedData))
+    );
+  }
+  return JSON.parse(localStorage.getItem(indexKey));
 }
 
 export function genIndex(path, content = '', router, depth) {
@@ -276,7 +294,7 @@ export function init(config, vm) {
 
   const isExpired = localStorage.getItem(expireKey) < Date.now();
 
-  INDEXS = JSON.parse(localStorage.getItem(indexKey));
+  INDEXS = getData(indexKey, config.largeContent);
 
   if (isExpired) {
     INDEXS = {};
@@ -295,7 +313,8 @@ export function init(config, vm) {
     Docsify.get(vm.router.getFile(path), false, vm.config.requestHeaders).then(
       result => {
         INDEXS[path] = genIndex(path, result, vm.router, config.depth);
-        len === ++count && saveData(config.maxAge, expireKey, indexKey);
+        len === ++count &&
+          saveData(config.maxAge, expireKey, indexKey, config.largeContent);
       },
     );
   });