feat(doc): rename readme for security check

Tencent · Apr 16, 2024 · 9bd3383 · 9bd3383
1 parent 7c13a42
commit 9bd3383
Show file tree

Hide file tree

Showing 13 changed files with 22 additions and 22 deletions.
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -13,6 +13,6 @@
 * iOS 增量 1MB，Android 增量最小 2.5MB
 
 [GitHub](//github.com/Tencent/Hippy)
-[快速开始](/README.md)
+[快速开始](/index.md)
 
 ![color](#fff)
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -1,5 +1,5 @@
 * 起步
-  * [Hippy 概述](/README?id=hippy-%e6%a6%82%e8%bf%b0)
+  * [Hippy 概述](/index?id=hippy-%e6%a6%82%e8%bf%b0)
   * [开始接入](guide/integration.md)
   * [架构](structure/introduction.md)
   * [调试](guide/debug.md)

diff --git a/docs/assets/js/docsify.js b/docs/assets/js/docsify.js
@@ -403,7 +403,7 @@
     return new RegExp(("\\.(" + (ext.replace(/^\./, '')) + "|html)$"), 'g').test(path)
       ? path
       : /\/$/g.test(path)
-        ? (path + "README" + ext)
+        ? (path + "index" + ext)
         : ("" + path + ext);
   }
 
@@ -425,7 +425,7 @@
 
     path = config.alias ? getAlias(path, config.alias) : path;
     path = getFileName(path, ext);
-    path = path === ("/README" + ext) ? config.homepage || path : path;
+    path = path === ("/index" + ext) ? config.homepage || path : path;
     path = isAbsolutePath(path) ? path : getPath(base, path);
 
     if (isRelative) {
@@ -2552,7 +2552,7 @@
         subMaxLevel: 0,
         loadSidebar: null,
         loadNavbar: null,
-        homepage: 'README.md',
+        homepage: 'index.md',
         coverpage: '',
         basePath: '',
         auto2top: false,
@@ -7694,7 +7694,7 @@
         !config.ignore
       ) {
         if (href === compilerClass.config.homepage) {
-          href = 'README';
+          href = 'index';
         }
 
         href = router.toURL(href, null, router.getCurrentPath());

diff --git a/docs/assets/js/docsify.min.js b/docs/assets/js/docsify.min.js
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
@@ -314,11 +314,11 @@
         }
       }
       var isExistHome = paths.indexOf(namespaceSuffix + '/') === -1;
-      var isExistReadme = paths.indexOf(namespaceSuffix + '/README') === -1;
+      var isExistReadme = paths.indexOf(namespaceSuffix + '/index') === -1;
       if (isExistHome && isExistReadme) {
         paths.unshift(namespaceSuffix + '/');
       }
-    } else if (paths.indexOf('/') === -1 && paths.indexOf('/README') === -1) {
+    } else if (paths.indexOf('/') === -1 && paths.indexOf('/index') === -1) {
       paths.unshift('/');
     }
 

diff --git a/docs/assets/js/search.min.js b/docs/assets/js/search.min.js
diff --git a/docs/en-us/_coverpage.md b/docs/en-us/_coverpage.md
@@ -13,6 +13,6 @@
 * iOS 增量 1MB，Android 增量最小 2.5MB
 
 [GitHub](//github.com/Tencent/Hippy)
-[快速开始](/README.md)
+[快速开始](/index.md)
 
 ![color](#fff)
diff --git a/docs/en-us/_navbar.md b/docs/en-us/_navbar.md
@@ -1,5 +1,5 @@
 * Get Started
-  * [OverView](/README?id=hippy-%e6%a6%82%e8%bf%b0)
+  * [OverView](/index?id=hippy-%e6%a6%82%e8%bf%b0)
   * [Get Started](guide/integration.md)
   * [Architecture](structure/introduction.md)
   * [Debug](guide/debug.md)

diff --git a/docs/en-us/assets/js/docsify.js b/docs/en-us/assets/js/docsify.js
@@ -403,7 +403,7 @@
     return new RegExp(("\\.(" + (ext.replace(/^\./, '')) + "|html)$"), 'g').test(path)
       ? path
       : /\/$/g.test(path)
-        ? (path + "README" + ext)
+        ? (path + "index" + ext)
         : ("" + path + ext);
   }
 
@@ -425,7 +425,7 @@
 
     path = config.alias ? getAlias(path, config.alias) : path;
     path = getFileName(path, ext);
-    path = path === ("/README" + ext) ? config.homepage || path : path;
+    path = path === ("/index" + ext) ? config.homepage || path : path;
     path = isAbsolutePath(path) ? path : getPath(base, path);
 
     if (isRelative) {
@@ -2552,7 +2552,7 @@
         subMaxLevel: 0,
         loadSidebar: null,
         loadNavbar: null,
-        homepage: 'README.md',
+        homepage: 'index.md',
         coverpage: '',
         basePath: '',
         auto2top: false,
@@ -7694,7 +7694,7 @@
         !config.ignore
       ) {
         if (href === compilerClass.config.homepage) {
-          href = 'README';
+          href = 'index';
         }
 
         href = router.toURL(href, null, router.getCurrentPath());

diff --git a/docs/en-us/assets/js/docsify.min.js b/docs/en-us/assets/js/docsify.min.js
diff --git a/docs/en-us/assets/js/search.js b/docs/en-us/assets/js/search.js
@@ -314,11 +314,11 @@
         }
       }
       var isExistHome = paths.indexOf(namespaceSuffix + '/') === -1;
-      var isExistReadme = paths.indexOf(namespaceSuffix + '/README') === -1;
+      var isExistReadme = paths.indexOf(namespaceSuffix + '/index') === -1;
       if (isExistHome && isExistReadme) {
         paths.unshift(namespaceSuffix + '/');
       }
-    } else if (paths.indexOf('/') === -1 && paths.indexOf('/README') === -1) {
+    } else if (paths.indexOf('/') === -1 && paths.indexOf('/index') === -1) {
       paths.unshift('/');
     }
 

diff --git a/docs/en-us/assets/js/search.min.js b/docs/en-us/assets/js/search.min.js
diff --git a/docs/README.md → docs/index.md b/docs/README.md → docs/index.md