Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(doc): rename readme for security check #3827

Merged
merged 1 commit into from
Apr 16, 2024
Merged

feat(doc): rename readme for security check #3827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_coverpage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@
* iOS 增量 1MB，Android 增量最小 2.5MB

[GitHub](//github.com/Tencent/Hippy)
[快速开始](/README.md)
[快速开始](/index.md)

![color](#fff)
2 changes: 1 addition & 1 deletion docs/_navbar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
8 changes: 4 additions & 4 deletions docs/assets/js/docsify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand All @@ -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) {
Expand Down Expand Up @@ -2552,7 +2552,7 @@
subMaxLevel: 0,
loadSidebar: null,
loadNavbar: null,
homepage: 'README.md',
homepage: 'index.md',
coverpage: '',
basePath: '',
auto2top: false,
Expand Down Expand Up @@ -7694,7 +7694,7 @@
!config.ignore
) {
if (href === compilerClass.config.homepage) {
href = 'README';
href = 'index';
}

href = router.toURL(href, null, router.getCurrentPath());
Expand Down
4 changes: 2 additions & 2 deletions docs/assets/js/docsify.min.js
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/assets/js/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
}

Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.min.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/en-us/_coverpage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@
* iOS 增量 1MB，Android 增量最小 2.5MB

[GitHub](//github.com/Tencent/Hippy)
[快速开始](/README.md)
[快速开始](/index.md)

![color](#fff)
2 changes: 1 addition & 1 deletion docs/en-us/_navbar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
8 changes: 4 additions & 4 deletions docs/en-us/assets/js/docsify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand All @@ -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) {
Expand Down Expand Up @@ -2552,7 +2552,7 @@
subMaxLevel: 0,
loadSidebar: null,
loadNavbar: null,
homepage: 'README.md',
homepage: 'index.md',
coverpage: '',
basePath: '',
auto2top: false,
Expand Down Expand Up @@ -7694,7 +7694,7 @@
!config.ignore
) {
if (href === compilerClass.config.homepage) {
href = 'README';
href = 'index';
}

href = router.toURL(href, null, router.getCurrentPath());
Expand Down
4 changes: 2 additions & 2 deletions docs/en-us/assets/js/docsify.min.js
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/en-us/assets/js/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
}

Expand Down
2 changes: 1 addition & 1 deletion docs/en-us/assets/js/search.min.js
View file
Open in desktop

Large diffs are not rendered by default.

0 docs/README.md → docs/index.md
View file
Open in desktop
File renamed without changes.
Loading