Skip to content

Commit 328eb2c

Browse files
committed
Format all documentation
1 parent f81358f commit 328eb2c

File tree

165 files changed

+2561
-2692
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

165 files changed

+2561
-2692
lines changed
Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
<template>
2-
<div class="notification-container">
3-
<div class="outdated-tip">
4-
<p>⚡当前语言可能更新不及时,最新信息请以 <a href="/" target="_blank" rel="noopener noreferrer">英文文档</a> 为准。如果翻译有问题,请 <a href="https://github.com/flarum/docs/issues" target="_blank" rel="noopener noreferrer"> 告诉我们</a>。</p>
5-
</div>
2+
<div class="notification-container">
3+
<div class="outdated-tip">
4+
<p>
5+
⚡当前语言可能更新不及时,最新信息请以
6+
<a href="/" target="_blank" rel="noopener noreferrer">英文文档</a>
7+
为准。如果翻译有问题,请
8+
<a href="https://github.com/flarum/docs/issues" target="_blank" rel="noopener noreferrer"> 告诉我们</a>。
9+
</p>
610
</div>
11+
</div>
712
</template>
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
<template>
2-
<div class="notification-container">
3-
<div class="processing-tip">
4-
<p>⚡当前文档仍在翻译中(进度 6/23),有关最新信息,请查阅 <a href="/extend/" target="_blank" rel="noopener noreferrer">英文文档</a>。如果翻译有问题,请 <a href="https://github.com/flarum/docs/issues" target="_blank" rel="noopener noreferrer">告诉我们</a>。</p>
5-
</div>
2+
<div class="notification-container">
3+
<div class="processing-tip">
4+
<p>
5+
⚡当前文档仍在翻译中(进度 6/23),有关最新信息,请查阅
6+
<a href="/extend/" target="_blank" rel="noopener noreferrer">英文文档</a>。如果翻译有问题,请
7+
<a href="https://github.com/flarum/docs/issues" target="_blank" rel="noopener noreferrer">告诉我们</a>。
8+
</p>
69
</div>
10+
</div>
711
</template>

docs/.vuepress/config.js

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
const locales = require('./config/locales');
22

3-
module.exports = ctx => ({
3+
module.exports = (ctx) => ({
44
base: '/',
55

66
head: require('./config/head'),
@@ -9,15 +9,21 @@ module.exports = ctx => ({
99
locales: locales.get(),
1010

1111
head: [
12-
['link', { href: 'https://fonts.googleapis.com/css2?family=Mukta:wght@200;400;600&amp;display=swap', rel: 'stylesheet' }]
12+
[
13+
'link',
14+
{
15+
href: 'https://fonts.googleapis.com/css2?family=Mukta:wght@200;400;600&amp;display=swap',
16+
rel: 'stylesheet',
17+
},
18+
],
1319
],
1420

1521
themeConfig: {
16-
logo: "/logo-docs.svg",
22+
logo: '/logo-docs.svg',
1723

1824
algolia: ctx.isProd && {
19-
apiKey: '8f760cdb850b1e696b72329eed96b01b',
20-
indexName: 'flarum'
25+
apiKey: '8f760cdb850b1e696b72329eed96b01b',
26+
indexName: 'flarum',
2127
},
2228
searchPlaceholder: 'Search Docs',
2329

@@ -27,4 +33,4 @@ module.exports = ctx => ({
2733

2834
locales: locales.theme(),
2935
},
30-
})
36+
});

docs/.vuepress/config/head.js

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ module.exports = [
55
rel: 'icon',
66
type: 'image/png',
77
size: '32x32',
8-
href: '/favicon-32x32.png'
9-
}
10-
], [
8+
href: '/favicon-32x32.png',
9+
},
10+
],
11+
[
1112
'link',
1213
{
1314
rel: 'icon',
1415
type: 'image/png',
1516
size: '192x192',
16-
href: '/favicon-192x192.png'
17-
}
18-
]
19-
]
17+
href: '/favicon-192x192.png',
18+
},
19+
],
20+
];
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
module.exports = {
2-
lang: 'en',
3-
title: 'Flarum Documentation',
4-
}
2+
lang: 'en',
3+
title: 'Flarum Documentation',
4+
};
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
module.exports = [
2-
{ text: 'Guide', link: '/' },
3-
{ text: 'Extend', link: '/extend/' },
4-
{ text: 'API Reference', link: 'https://api.docs.flarum.org/' },
5-
{
6-
text: 'Flarum',
7-
items: [
8-
{ text: 'Home', link: 'https://flarum.org/' },
9-
{ text: 'Community', link: 'https://discuss.flarum.org/' },
10-
{ text: 'GitHub', link: 'https://github.com/flarum/flarum/' },
11-
]
12-
}
13-
]
2+
{ text: 'Guide', link: '/' },
3+
{ text: 'Extend', link: '/extend/' },
4+
{ text: 'API Reference', link: 'https://api.docs.flarum.org/' },
5+
{
6+
text: 'Flarum',
7+
items: [
8+
{ text: 'Home', link: 'https://flarum.org/' },
9+
{ text: 'Community', link: 'https://discuss.flarum.org/' },
10+
{ text: 'GitHub', link: 'https://github.com/flarum/flarum/' },
11+
],
12+
},
13+
];

docs/.vuepress/config/locales/en/sidebar.js

Lines changed: 11 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@ module.exports = {
33
{
44
title: 'Main Concepts',
55
collapsable: false,
6-
children: [
7-
'',
8-
'start',
9-
'frontend',
10-
'routes',
11-
'data',
12-
'distribution'
13-
]
6+
children: ['', 'start', 'frontend', 'routes', 'data', 'distribution'],
147
},
158
{
169
title: 'Reference Guides',
@@ -25,8 +18,8 @@ module.exports = {
2518
'forms',
2619
'permissions',
2720
'settings',
28-
'testing'
29-
]
21+
'testing',
22+
],
3023
},
3124
{
3225
title: 'Advanced Guides',
@@ -43,21 +36,13 @@ module.exports = {
4336
'notifications',
4437
'post-types',
4538
'search',
46-
'service-provider'
47-
]
39+
'service-provider',
40+
],
4841
},
4942
{
5043
title: 'Update Guides',
5144
collapsable: false,
52-
children: [
53-
'update-b16',
54-
'update-b15',
55-
'update-b14',
56-
'update-b13',
57-
'update-b12',
58-
'update-b10',
59-
'update-b8',
60-
]
45+
children: ['update-b16', 'update-b15', 'update-b14', 'update-b13', 'update-b12', 'update-b10', 'update-b8'],
6146
},
6247
// {
6348
// title: 'Themes',
@@ -78,36 +63,17 @@ module.exports = {
7863
{
7964
title: 'Introduction',
8065
collapsable: false,
81-
children: [
82-
'',
83-
'code-of-conduct',
84-
'releases',
85-
'contributing',
86-
'bugs',
87-
'faq'
88-
]
66+
children: ['', 'code-of-conduct', 'releases', 'contributing', 'bugs', 'faq'],
8967
},
9068
{
9169
title: 'Setting Up',
9270
collapsable: false,
93-
children: [
94-
'install',
95-
'update',
96-
'troubleshoot'
97-
]
71+
children: ['install', 'update', 'troubleshoot'],
9872
},
9973
{
10074
title: 'Management',
10175
collapsable: false,
102-
children: [
103-
'admin',
104-
'config',
105-
'extensions',
106-
'languages',
107-
'themes',
108-
'mail',
109-
'console'
110-
]
111-
}
76+
children: ['admin', 'config', 'extensions', 'languages', 'themes', 'mail', 'console'],
77+
},
11278
],
113-
}
79+
};
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
module.exports = {
2-
selectText: 'Languages',
3-
label: 'English',
2+
selectText: 'Languages',
3+
label: 'English',
44

5-
searchPlaceholder: 'Search Docs',
6-
7-
editLinkText: 'Edit this page',
8-
lastUpdated: 'Last Updated',
5+
searchPlaceholder: 'Search Docs',
96

10-
nav: require('./nav'),
11-
sidebar: require('./sidebar'),
12-
}
7+
editLinkText: 'Edit this page',
8+
lastUpdated: 'Last Updated',
9+
10+
nav: require('./nav'),
11+
sidebar: require('./sidebar'),
12+
};

docs/.vuepress/config/locales/index.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ const paths = { en: '/' };
33

44
module.exports = {
55
get(file = '') {
6-
return langs.reduce((locales, name) => {
7-
locales[paths[name] || `/${name}/`] = require(`./${name}${file}`);
6+
return langs.reduce((locales, name) => {
7+
locales[paths[name] || `/${name}/`] = require(`./${name}${file}`);
88

9-
return locales;
10-
}, {});
9+
return locales;
10+
}, {});
1111
},
1212

1313
theme() {
1414
return this.get('/theme');
15-
}
16-
}
15+
},
16+
};
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
module.exports = {
2-
lang: 'it',
3-
title: 'Documentazione di Flarum',
4-
}
2+
lang: 'it',
3+
title: 'Documentazione di Flarum',
4+
};

0 commit comments

Comments
 (0)