Skip to content

Commit 4add07f

Browse files
davwheatdavwheat
committed
Format docs repo
1 parent b980dec commit 4add07f

File tree

214 files changed

+3626
-3870
lines changed

Some content is hidden

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

214 files changed

+3626
-3870
lines changed

‎docs/.vuepress/config.js

Lines changed: 11 additions & 7 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'),
@@ -10,21 +10,25 @@ module.exports = ctx => ({
1010

1111
head: [
1212
['link', { href: 'https://fonts.googleapis.com/css2?family=Mukta:wght@200;400;600&display=swap', rel: 'stylesheet' }],
13-
['script', {id: "scriptImporter"}, `
13+
[
14+
'script',
15+
{ id: 'scriptImporter' },
16+
`
1417
(function() {
1518
var script = document.createElement("script");
1619
script.src = "/js/i18n.js";
1720
setTimeout(() => document.body.append(script))
1821
})();
19-
`]
22+
`,
23+
],
2024
],
2125

2226
themeConfig: {
23-
logo: "/logo-docs.svg",
27+
logo: '/logo-docs.svg',
2428

2529
algolia: ctx.isProd && {
26-
apiKey: '8f760cdb850b1e696b72329eed96b01b',
27-
indexName: 'flarum'
30+
apiKey: '8f760cdb850b1e696b72329eed96b01b',
31+
indexName: 'flarum',
2832
},
2933
searchPlaceholder: 'Search Docs',
3034

@@ -34,4 +38,4 @@ module.exports = ctx => ({
3438

3539
locales: locales.theme(),
3640
},
37-
})
41+
});

‎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+
];

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

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+
};

‎docs/.vuepress/config/locales/en/nav.js

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: 12 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,7 @@ module.exports = {
33
{
44
title: 'Main Concepts',
55
collapsable: false,
6-
children: [
7-
'',
8-
'start',
9-
'frontend',
10-
'routes',
11-
'models',
12-
'api',
13-
'distribution'
14-
]
6+
children: ['', 'start', 'frontend', 'routes', 'models', 'api', 'distribution'],
157
},
168
{
179
title: 'Reference Guides',
@@ -27,8 +19,8 @@ module.exports = {
2719
'permissions',
2820
'settings',
2921
'testing',
30-
'theme'
31-
]
22+
'theme',
23+
],
3224
},
3325
{
3426
title: 'Advanced Guides',
@@ -45,21 +37,13 @@ module.exports = {
4537
'notifications',
4638
'post-types',
4739
'search',
48-
'service-provider'
49-
]
40+
'service-provider',
41+
],
5042
},
5143
{
5244
title: 'Update Guides',
5345
collapsable: false,
54-
children: [
55-
'update-b16',
56-
'update-b15',
57-
'update-b14',
58-
'update-b13',
59-
'update-b12',
60-
'update-b10',
61-
'update-b8',
62-
]
46+
children: ['update-b16', 'update-b15', 'update-b14', 'update-b13', 'update-b12', 'update-b10', 'update-b8'],
6347
},
6448
// {
6549
// title: 'Themes',
@@ -80,44 +64,22 @@ module.exports = {
8064
{
8165
title: 'Introduction',
8266
collapsable: false,
83-
children: [
84-
'',
85-
'code-of-conduct',
86-
'releases',
87-
'contributing',
88-
'bugs',
89-
'faq'
90-
]
67+
children: ['', 'code-of-conduct', 'releases', 'contributing', 'bugs', 'faq'],
9168
},
9269
{
9370
title: 'Setting Up',
9471
collapsable: false,
95-
children: [
96-
'composer',
97-
'install',
98-
'update',
99-
'troubleshoot'
100-
]
72+
children: ['composer', 'install', 'update', 'troubleshoot'],
10173
},
10274
{
10375
title: 'Management',
10476
collapsable: false,
105-
children: [
106-
'admin',
107-
'config',
108-
'extensions',
109-
'languages',
110-
'themes',
111-
'mail',
112-
'console'
113-
]
77+
children: ['admin', 'config', 'extensions', 'languages', 'themes', 'mail', 'console'],
11478
},
11579
{
11680
title: 'Advanced',
11781
collapsable: false,
118-
children: [
119-
'extenders'
120-
]
121-
}
82+
children: ['extenders'],
83+
},
12284
],
123-
}
85+
};

‎docs/.vuepress/config/locales/en/theme.js

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/es/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
module.exports = {
2-
lang: 'es',
3-
title: 'Documentación de Flarum',
4-
}
2+
lang: 'es',
3+
title: 'Documentación de Flarum',
4+
};

‎docs/.vuepress/config/locales/es/nav.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
module.exports = [
2-
{ text: 'Guía', link: '/es/' },
3-
{ text: 'Extender', link: '/es/extend/' },
4-
{ text: 'Referencia de la API', link: 'https://api.docs.flarum.org/' },
5-
{
6-
text: 'Flarum',
7-
items: [
8-
{ text: 'Inicio', link: 'https://flarum.org/' },
9-
{ text: 'Comunidad', link: 'https://discuss.flarum.org/' },
10-
{ text: 'GitHub', link: 'https://github.com/flarum/flarum/' },
11-
]
12-
}
13-
]
2+
{ text: 'Guía', link: '/es/' },
3+
{ text: 'Extender', link: '/es/extend/' },
4+
{ text: 'Referencia de la API', link: 'https://api.docs.flarum.org/' },
5+
{
6+
text: 'Flarum',
7+
items: [
8+
{ text: 'Inicio', link: 'https://flarum.org/' },
9+
{ text: 'Comunidad', link: 'https://discuss.flarum.org/' },
10+
{ text: 'GitHub', link: 'https://github.com/flarum/flarum/' },
11+
],
12+
},
13+
];

‎docs/.vuepress/config/locales/es/sidebar.js

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,12 @@ module.exports = {
33
{
44
title: 'Conceptos Principales',
55
collapsable: false,
6-
children: [
7-
'',
8-
'start',
9-
'frontend',
10-
'routes',
11-
'data',
12-
'distribution',
13-
'update-b16',
14-
]
6+
children: ['', 'start', 'frontend', 'routes', 'data', 'distribution', 'update-b16'],
157
},
168
{
179
title: 'Guías de Referencia',
1810
collapsable: false,
19-
children: [
20-
'admin',
21-
'frontend-pages',
22-
'interactive-components',
23-
'forms',
24-
'backend-events',
25-
]
11+
children: ['admin', 'frontend-pages', 'interactive-components', 'forms', 'backend-events'],
2612
},
2713
{
2814
title: 'Guías Avanzadas',
@@ -43,7 +29,7 @@ module.exports = {
4329
'service-provider',
4430
'settings',
4531
'testing',
46-
]
32+
],
4733
},
4834
// {
4935
// title: 'Themes',
@@ -64,36 +50,17 @@ module.exports = {
6450
{
6551
title: 'Introducción',
6652
collapsable: false,
67-
children: [
68-
'',
69-
'code-of-conduct',
70-
'releases',
71-
'contributing',
72-
'bugs',
73-
'faq'
74-
]
53+
children: ['', 'code-of-conduct', 'releases', 'contributing', 'bugs', 'faq'],
7554
},
7655
{
7756
title: 'Configuración',
7857
collapsable: false,
79-
children: [
80-
'install',
81-
'update',
82-
'troubleshoot'
83-
]
58+
children: ['install', 'update', 'troubleshoot'],
8459
},
8560
{
8661
title: 'Gestión',
8762
collapsable: false,
88-
children: [
89-
'admin',
90-
'config',
91-
'extensions',
92-
'languages',
93-
'themes',
94-
'mail',
95-
'console'
96-
]
97-
}
63+
children: ['admin', 'config', 'extensions', 'languages', 'themes', 'mail', 'console'],
64+
},
9865
],
99-
}
66+
};

‎docs/.vuepress/config/locales/es/theme.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
module.exports = {
2-
selectText: 'Idiomas',
3-
label: 'Español',
2+
selectText: 'Idiomas',
3+
label: 'Español',
44

5-
searchPlaceholder: 'Buscar Documentos',
6-
7-
editLinkText: 'Editar esta página',
8-
lastUpdated: 'Última actualización',
5+
searchPlaceholder: 'Buscar Documentos',
96

10-
nav: require('./nav'),
11-
sidebar: require('./sidebar'),
12-
}
7+
editLinkText: 'Editar esta página',
8+
lastUpdated: 'Última actualización',
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+
};

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

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)