Skip to content

Commit a2c449e

Browse files
anwen-anyixhofe
andauthored
docs: Update Docs (#211)
* update AList v3 Docs * update ali-open * del ali-open * update site config docs * add sso Casdoor Docs * add faq Docs * add faq-wht Docs * add sso login Casdoor * fix build error * update vuepress-theme-hope version * test update * Update pnpm-lock.yaml * adapt new version * rename ads to ss --------- Co-authored-by: Andy Hsu <[email protected]>
1 parent e84cbef commit a2c449e

39 files changed

+2270
-1743
lines changed

docs/.vuepress/components/HomePage.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<span>🌈 {{ spStr }}</span>
66
<div class="mingdao">
77
<a href="https://www.mingdao.com?s=utm_51=utm_source=alist&utm_medium=banner&utm_campaign=%E5%93%81%E7%89%8C%E6%8E%A8%E5%B9%BF&utm_content=IT%E8%B5%8B%E8%83%BD%E4%B8%9A%E5%8A%A1"
8-
target="_blank"><img src="/img/ads/mingdao-h.png" alt="" /></a>
8+
target="_blank"><img src="/img/ss/mingdao-h.png" alt="" /></a>
99
</div>
1010
</div>
1111
<div class="hero-info-wrapper wwads-container">

docs/.vuepress/components/NormalPage.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<div class="mingdao" v-if="showMingdao">
66
<a href="https://www.mingdao.com?s=utm_51=utm_source=alist&utm_medium=banner&utm_campaign=%E5%93%81%E7%89%8C%E6%8E%A8%E5%B9%BF&utm_content=IT%E8%B5%8B%E8%83%BD%E4%B8%9A%E5%8A%A1"
77
target="_blank">
8-
<img src="/img/ads/mingdao-h.png" alt="" />
8+
<img src="/img/ss/mingdao-h.png" alt="" />
99
<span>{{ spStr }}</span>
1010
</a>
1111
</div>

docs/.vuepress/components/Sidebar.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<div class="ss">
55
<div class="mingdao">
66
<a href="https://www.mingdao.com?s=utm_51=utm_source=alist&utm_medium=banner&utm_campaign=%E5%93%81%E7%89%8C%E6%8E%A8%E5%B9%BF&utm_content=IT%E8%B5%8B%E8%83%BD%E4%B8%9A%E5%8A%A1"
7-
target="_blank"><img src="/img/ads/mingdao.png" alt="" /></a>
7+
target="_blank"><img src="/img/ss/mingdao.png" alt="" /></a>
88
<span>{{ spStr }}</span>
99
</div>
1010
</div>
97.4 KB
Loading
118 KB
Loading
16.2 KB
Loading

docs/.vuepress/theme.ts

Lines changed: 107 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -2,124 +2,134 @@ import { hopeTheme } from "vuepress-theme-hope";
22
import * as navbar from "./navbar";
33
import * as sidebar from "./sidebar";
44

5-
export default hopeTheme({
6-
hostname: "https://alist.nn.ci",
7-
themeColor: {
8-
blue: "#2196f3",
9-
red: "#f26d6d",
10-
green: "#3eaf7c",
11-
orange: "#fb9b5f",
12-
},
5+
export default hopeTheme(
6+
{
7+
hostname: "https://alist.nn.ci",
8+
themeColor: {
9+
blue: "#2196f3",
10+
red: "#f26d6d",
11+
green: "#3eaf7c",
12+
orange: "#fb9b5f",
13+
},
1314

14-
author: {
15-
name: "Andy Hsu",
16-
url: "https://i.nn.ci",
17-
},
15+
author: {
16+
name: "Andy Hsu",
17+
url: "https://i.nn.ci",
18+
},
1819

19-
iconAssets: "iconfont",
20+
iconAssets: "iconfont",
2021

21-
logo: "/logo.svg",
22+
logo: "/logo.svg",
2223

23-
repo: "alist-org/docs",
24+
repo: "alist-org/docs",
2425

25-
docsDir: "docs",
26+
docsDir: "docs",
2627

27-
pageInfo: ["Author", "Original", "Date", "Category", "Tag", "ReadingTime"],
28+
pageInfo: ["Author", "Original", "Date", "Category", "Tag", "ReadingTime"],
2829

29-
locales: {
30-
"/": {
31-
// navbar
32-
navbar: navbar.en,
30+
locales: {
31+
"/": {
32+
// navbar
33+
navbar: navbar.en,
3334

34-
// sidebar
35-
sidebar: sidebar.en,
35+
// sidebar
36+
sidebar: sidebar.en,
3637

37-
footer: `<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-bg.svg" alt="Deploys by Netlify" /> </a>
38+
footer: `<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-bg.svg" alt="Deploys by Netlify" /> </a>
3839
<script src="/adb.js" type="text/javascript"></script>
3940
`,
4041

41-
displayFooter: true,
42-
},
42+
displayFooter: true,
43+
},
4344

44-
/**
45-
* Chinese locale config
46-
*/
47-
"/zh/": {
48-
// navbar
49-
navbar: navbar.zh,
45+
/**
46+
* Chinese locale config
47+
*/
48+
"/zh/": {
49+
// navbar
50+
navbar: navbar.zh,
5051

51-
// sidebar
52-
sidebar: sidebar.zh,
52+
// sidebar
53+
sidebar: sidebar.zh,
5354

54-
footer: `<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-bg.svg" alt="Deploys by Netlify" /> </a>
55+
footer: `<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-bg.svg" alt="Deploys by Netlify" /> </a>
5556
<script src="/adb.js" type="text/javascript"></script>`,
5657

57-
displayFooter: true,
58+
displayFooter: true,
59+
},
5860
},
59-
},
6061

61-
// encrypt: {
62-
// config: {
63-
// "/guide/encrypt.html": ["1234"],
64-
// "/zh/guide/encrypt.html": ["1234"],
65-
// },
66-
// },
67-
68-
plugins: {
69-
autoCatalog: {
70-
frontmatter: () => ({
71-
toc: false,
72-
}),
73-
},
74-
// blog: {
75-
// autoExcerpt: true,
62+
// encrypt: {
63+
// config: {
64+
// "/guide/encrypt.html": ["1234"],
65+
// "/zh/guide/encrypt.html": ["1234"],
66+
// },
7667
// },
7768

78-
// If you don't need comment feature, you can remove following option
79-
// The following config is for demo ONLY, if you need comment feature, please generate and use your own config, see comment plugin documentation for details.
80-
// To avoid disturbing the theme developer and consuming his resources, please DO NOT use the following config directly in your production environment!!!!!
81-
comment: {
82-
/**
83-
* Using Giscus
84-
*/
85-
provider: "Giscus",
86-
repo: "alist-org/docs",
87-
repoId: "R_kgDOHmaM-A",
88-
category: "Announcements",
89-
categoryId: "DIC_kwDOHmaM-M4CRRXl",
90-
91-
/**
92-
* Using Twikoo
93-
*/
94-
// provider: "Twikoo",
95-
// envId: "https://twikoo.ccknbc.vercel.app",
96-
97-
/**
98-
* Using Waline
99-
*/
100-
// provider: "Waline",
101-
// serverURL: "https://vuepress-theme-hope-comment.vercel.app",
102-
},
103-
104-
mdEnhance: {
105-
// enableAll: true,
106-
// presentation: {
107-
// plugins: ["highlight", "math", "search", "notes", "zoom"],
69+
plugins: {
70+
autoCatalog: {
71+
frontmatter: () => ({
72+
toc: false,
73+
}),
74+
},
75+
// blog: {
76+
// autoExcerpt: true,
10877
// },
109-
container: true,
110-
linkCheck: "dev",
111-
tabs: true,
112-
tasklist: true,
113-
gfm: true,
114-
flowchart: true,
115-
mark: true,
116-
mermaid: true,
117-
sub: true,
118-
sup: true,
119-
align: true,
120-
},
121-
components: {
122-
components: ["ArtPlayer", "BiliBili", "Badge"],
78+
79+
// If you don't need comment feature, you can remove following option
80+
// The following config is for demo ONLY, if you need comment feature, please generate and use your own config, see comment plugin documentation for details.
81+
// To avoid disturbing the theme developer and consuming his resources, please DO NOT use the following config directly in your production environment!!!!!
82+
comment: {
83+
/**
84+
* Using Giscus
85+
*/
86+
provider: "Giscus",
87+
repo: "alist-org/docs",
88+
repoId: "R_kgDOHmaM-A",
89+
category: "Announcements",
90+
categoryId: "DIC_kwDOHmaM-M4CRRXl",
91+
92+
/**
93+
* Using Twikoo
94+
*/
95+
// provider: "Twikoo",
96+
// envId: "https://twikoo.ccknbc.vercel.app",
97+
98+
/**
99+
* Using Waline
100+
*/
101+
// provider: "Waline",
102+
// serverURL: "https://vuepress-theme-hope-comment.vercel.app",
103+
},
104+
105+
mdEnhance: {
106+
// enableAll: true,
107+
// presentation: {
108+
// plugins: ["highlight", "math", "search", "notes", "zoom"],
109+
// },
110+
container: true,
111+
checkLinks: {
112+
status: "dev",
113+
},
114+
tabs: true,
115+
tasklist: true,
116+
gfm: true,
117+
flowchart: true,
118+
mark: true,
119+
mermaid: true,
120+
sub: true,
121+
sup: true,
122+
align: true,
123+
},
124+
components: {
125+
components: ["ArtPlayer", "BiliBili", "Badge"],
126+
},
123127
},
124128
},
125-
});
129+
{
130+
check: true,
131+
compact: true,
132+
custom: true,
133+
debug: false,
134+
}
135+
);

docs/config/README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,4 @@ category:
66
- Config
77
---
88

9-
## Catalog
10-
11-
- [Configuration file](configuration.md)
12-
13-
- [Site Settings](site.md)
14-
15-
- [Style Settings](style.md)
16-
17-
- [Preview Settings](preview.md)
18-
19-
- [Global Settings](global.md)
20-
21-
- [Other settings](other.md)
9+
<AutoCatalog />

0 commit comments

Comments
 (0)