2018-08-28 11:23:59 +02:00
|
|
|
module.exports = {
|
2019-11-07 12:05:39 +01:00
|
|
|
title: 'Strapi Documentation',
|
|
|
|
|
description: 'The headless CMS developers love.',
|
2018-10-05 17:24:17 +02:00
|
|
|
base: '/documentation/',
|
2019-11-28 11:45:45 +01:00
|
|
|
plugins: [
|
|
|
|
|
'@vuepress/medium-zoom',
|
|
|
|
|
'vuepress-plugin-element-tabs',
|
|
|
|
|
[
|
|
|
|
|
'@vuepress/google-analytics',
|
|
|
|
|
{
|
|
|
|
|
ga: 'UA-54313258-1',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
],
|
2019-11-07 13:53:36 +01:00
|
|
|
head: [
|
|
|
|
|
[
|
|
|
|
|
'link',
|
|
|
|
|
{
|
|
|
|
|
rel: 'icon',
|
|
|
|
|
href: 'https://strapi.io/favicon.ico',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'og:title',
|
|
|
|
|
content: 'Strapi Documentation',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'og:type',
|
|
|
|
|
content: 'article',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'og:url',
|
|
|
|
|
content: 'https://strapi.io/documentation/',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'og:description',
|
|
|
|
|
content: 'The headless CMS developers love.',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'og:image',
|
|
|
|
|
content: 'https://strapi.io/assets/images/strapi-website-preview.png',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'og:article:author',
|
|
|
|
|
content: 'strapi',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'twitter:card',
|
|
|
|
|
content: 'summary_large_image',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'twitter:url',
|
|
|
|
|
content: 'https://strapi.io/documentation/',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'twitter:site',
|
|
|
|
|
content: '@strapijs',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'twitter:title',
|
|
|
|
|
content: 'Strapi Documentation',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'twitter:description',
|
|
|
|
|
content: 'The headless CMS developers love.',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
[
|
|
|
|
|
'meta',
|
|
|
|
|
{
|
|
|
|
|
property: 'twitter:image',
|
|
|
|
|
content: 'http://strapi.io/assets/images/strapi-website-preview.png',
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
],
|
2018-08-28 11:23:59 +02:00
|
|
|
themeConfig: {
|
2019-11-07 13:53:36 +01:00
|
|
|
nav: [
|
2019-11-07 12:05:39 +01:00
|
|
|
{
|
|
|
|
|
text: 'Versions',
|
|
|
|
|
items: [
|
|
|
|
|
{
|
2020-05-25 18:11:45 +02:00
|
|
|
text: 'Version 3.x',
|
|
|
|
|
link: '/v3.x/',
|
2019-11-07 12:05:39 +01:00
|
|
|
},
|
|
|
|
|
{
|
2020-05-25 18:11:45 +02:00
|
|
|
text: 'Version 3.0.0-beta.x',
|
|
|
|
|
link: '/3.0.0-beta.x/',
|
2019-11-07 12:05:39 +01:00
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
text: 'Website',
|
2019-11-26 16:58:35 +01:00
|
|
|
link: 'https://strapi.io',
|
2019-11-07 12:05:39 +01:00
|
|
|
},
|
|
|
|
|
{
|
2019-11-07 13:53:36 +01:00
|
|
|
text: 'Slack',
|
2019-11-07 12:05:39 +01:00
|
|
|
link: 'https://slack.strapi.io',
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
text: 'Blog',
|
2020-05-29 10:52:04 +02:00
|
|
|
link: 'https://strapi.io/blog',
|
2019-11-07 12:05:39 +01:00
|
|
|
},
|
2020-04-09 04:39:50 -07:00
|
|
|
{
|
|
|
|
|
text: 'Tutorials',
|
|
|
|
|
link: 'https://strapi.io/tutorials',
|
|
|
|
|
},
|
2019-11-07 13:53:36 +01:00
|
|
|
],
|
2018-09-28 11:04:07 +02:00
|
|
|
repo: 'strapi/strapi',
|
|
|
|
|
docsDir: 'docs',
|
2019-04-24 16:27:43 +02:00
|
|
|
algolia: {
|
|
|
|
|
apiKey: 'a93451de224096fb34471c8b8b049de7',
|
2019-07-02 15:09:59 +02:00
|
|
|
indexName: 'strapi',
|
2019-04-24 16:27:43 +02:00
|
|
|
},
|
2018-09-28 11:04:07 +02:00
|
|
|
editLinks: true,
|
|
|
|
|
editLinkText: 'Improve this page',
|
2018-09-28 10:20:08 +02:00
|
|
|
serviceWorker: true,
|
2019-11-07 12:05:39 +01:00
|
|
|
sidebarDepth: 1,
|
2018-09-28 10:20:08 +02:00
|
|
|
sidebar: {
|
2020-05-25 18:11:45 +02:00
|
|
|
'/v3.x/': [
|
|
|
|
|
{
|
|
|
|
|
collapsable: false,
|
|
|
|
|
title: '🚀 Getting Started',
|
|
|
|
|
children: [
|
|
|
|
|
['/v3.x/getting-started/introduction', 'Introduction'],
|
|
|
|
|
['/v3.x/getting-started/installation', 'Installation'],
|
|
|
|
|
['/v3.x/getting-started/deployment', 'Deployment'],
|
|
|
|
|
['/v3.x/getting-started/contributing', 'Contributing'],
|
|
|
|
|
['/v3.x/getting-started/troubleshooting', 'Troubleshooting'],
|
|
|
|
|
'/v3.x/getting-started/quick-start',
|
|
|
|
|
'/v3.x/getting-started/quick-start-tutorial',
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '📄 Content API',
|
|
|
|
|
children: ['/v3.x/content-api/api-endpoints', '/v3.x/content-api/parameters'],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '💡 Concepts',
|
|
|
|
|
children: [
|
|
|
|
|
'/v3.x/concepts/configurations',
|
|
|
|
|
'/v3.x/concepts/controllers',
|
|
|
|
|
'/v3.x/concepts/customization',
|
|
|
|
|
'/v3.x/concepts/file-structure',
|
|
|
|
|
'/v3.x/concepts/hooks',
|
|
|
|
|
'/v3.x/concepts/middlewares',
|
|
|
|
|
'/v3.x/concepts/models',
|
|
|
|
|
'/v3.x/concepts/plugins',
|
|
|
|
|
'/v3.x/concepts/policies',
|
|
|
|
|
'/v3.x/concepts/public-assets',
|
|
|
|
|
'/v3.x/concepts/queries',
|
|
|
|
|
'/v3.x/concepts/requests-responses',
|
|
|
|
|
'/v3.x/concepts/routing',
|
|
|
|
|
'/v3.x/concepts/services',
|
|
|
|
|
'/v3.x/concepts/webhooks',
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '📚 Guides',
|
|
|
|
|
children: [
|
|
|
|
|
'/v3.x/guides/api-token',
|
|
|
|
|
'/v3.x/guides/auth-request',
|
|
|
|
|
'/v3.x/guides/count-graphql',
|
|
|
|
|
'/v3.x/guides/slug',
|
|
|
|
|
'/v3.x/guides/is-owner',
|
|
|
|
|
'/v3.x/guides/custom-admin',
|
|
|
|
|
'/v3.x/guides/custom-data-response',
|
|
|
|
|
'/v3.x/guides/databases',
|
|
|
|
|
'/v3.x/guides/draft',
|
|
|
|
|
'/v3.x/guides/error-catching',
|
|
|
|
|
'/v3.x/guides/external-data',
|
|
|
|
|
'/v3.x/guides/jwt-validation',
|
|
|
|
|
'/v3.x/guides/process-manager',
|
|
|
|
|
'/v3.x/guides/scheduled-publication',
|
|
|
|
|
'/v3.x/guides/secure-your-app',
|
|
|
|
|
'/v3.x/guides/send-email',
|
|
|
|
|
'/v3.x/guides/registering-a-field-in-admin',
|
|
|
|
|
'/v3.x/guides/client',
|
|
|
|
|
'/v3.x/guides/update-version',
|
2020-05-26 17:58:53 +02:00
|
|
|
'/v3.x/guides/unit-testing',
|
2020-05-25 18:11:45 +02:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '⚙️️ Admin Panel',
|
|
|
|
|
children: [
|
|
|
|
|
'/v3.x/admin-panel/customization',
|
|
|
|
|
'/v3.x/admin-panel/custom-webpack-config',
|
|
|
|
|
'/v3.x/admin-panel/deploy',
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '📦 Plugins',
|
|
|
|
|
children: [
|
|
|
|
|
'/v3.x/plugins/documentation',
|
|
|
|
|
'/v3.x/plugins/email',
|
|
|
|
|
'/v3.x/plugins/graphql',
|
|
|
|
|
'/v3.x/plugins/upload',
|
|
|
|
|
'/v3.x/plugins/users-permissions',
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '🔌 Local Plugins',
|
|
|
|
|
children: [
|
|
|
|
|
'/v3.x/plugin-development/quick-start',
|
|
|
|
|
'/v3.x/plugin-development/plugin-architecture',
|
|
|
|
|
'/v3.x/plugin-development/backend-development',
|
|
|
|
|
'/v3.x/plugin-development/frontend-development',
|
|
|
|
|
'/v3.x/plugin-development/frontend-field-api',
|
|
|
|
|
'/v3.x/plugin-development/frontend-settings-api',
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '💻 Command Line Interface',
|
|
|
|
|
children: ['/v3.x/cli/CLI'],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '🏗 Global strapi',
|
|
|
|
|
children: ['/v3.x/global-strapi/api-reference', '/v3.x/global-strapi/usage-information'],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: false,
|
|
|
|
|
title: '📚 Resources',
|
|
|
|
|
children: [
|
|
|
|
|
['https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md', 'Contributing guide'],
|
|
|
|
|
'/v3.x/migration-guide/',
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
],
|
2019-05-07 17:00:37 +02:00
|
|
|
'/3.0.0-beta.x/': [
|
2019-05-06 16:17:16 +02:00
|
|
|
{
|
|
|
|
|
collapsable: false,
|
2019-11-07 13:53:36 +01:00
|
|
|
title: '🚀 Getting Started',
|
2019-05-06 16:17:16 +02:00
|
|
|
children: [
|
2020-02-10 14:21:18 +01:00
|
|
|
['/3.0.0-beta.x/getting-started/introduction', 'Introduction'],
|
|
|
|
|
['/3.0.0-beta.x/getting-started/installation', 'Installation'],
|
2020-03-23 02:29:11 -07:00
|
|
|
['/3.0.0-beta.x/getting-started/deployment', 'Deployment'],
|
2020-02-10 14:21:18 +01:00
|
|
|
['/3.0.0-beta.x/getting-started/contributing', 'Contributing'],
|
|
|
|
|
['/3.0.0-beta.x/getting-started/troubleshooting', 'Troubleshooting'],
|
2019-05-07 17:00:37 +02:00
|
|
|
'/3.0.0-beta.x/getting-started/quick-start',
|
|
|
|
|
'/3.0.0-beta.x/getting-started/quick-start-tutorial',
|
2019-05-06 16:17:16 +02:00
|
|
|
],
|
|
|
|
|
},
|
2019-10-05 17:58:59 +02:00
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '📄 Content API',
|
|
|
|
|
children: [
|
|
|
|
|
'/3.0.0-beta.x/content-api/api-endpoints',
|
|
|
|
|
'/3.0.0-beta.x/content-api/parameters',
|
|
|
|
|
],
|
|
|
|
|
},
|
2019-05-06 16:17:16 +02:00
|
|
|
{
|
|
|
|
|
collapsable: true,
|
2019-10-09 12:32:58 +02:00
|
|
|
title: '💡 Concepts',
|
|
|
|
|
children: [
|
|
|
|
|
'/3.0.0-beta.x/concepts/configurations',
|
|
|
|
|
'/3.0.0-beta.x/concepts/controllers',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/concepts/customization',
|
|
|
|
|
'/3.0.0-beta.x/concepts/file-structure',
|
2019-10-09 12:32:58 +02:00
|
|
|
'/3.0.0-beta.x/concepts/hooks',
|
|
|
|
|
'/3.0.0-beta.x/concepts/middlewares',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/concepts/models',
|
2019-10-09 12:32:58 +02:00
|
|
|
'/3.0.0-beta.x/concepts/plugins',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/concepts/policies',
|
|
|
|
|
'/3.0.0-beta.x/concepts/public-assets',
|
|
|
|
|
'/3.0.0-beta.x/concepts/queries',
|
2020-04-09 04:39:50 -07:00
|
|
|
'/3.0.0-beta.x/concepts/requests-responses',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/concepts/routing',
|
|
|
|
|
'/3.0.0-beta.x/concepts/services',
|
2020-01-10 12:06:00 +01:00
|
|
|
'/3.0.0-beta.x/concepts/webhooks',
|
2019-10-09 12:32:58 +02:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '📚 Guides',
|
2019-05-06 16:17:16 +02:00
|
|
|
children: [
|
2019-12-11 12:14:06 +01:00
|
|
|
'/3.0.0-beta.x/guides/api-token',
|
2019-12-24 12:19:07 +01:00
|
|
|
'/3.0.0-beta.x/guides/auth-request',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/guides/count-graphql',
|
2020-04-09 04:39:50 -07:00
|
|
|
'/3.0.0-beta.x/guides/slug',
|
2020-02-19 17:08:16 +01:00
|
|
|
'/3.0.0-beta.x/guides/is-owner',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/guides/custom-admin',
|
|
|
|
|
'/3.0.0-beta.x/guides/custom-data-response',
|
|
|
|
|
'/3.0.0-beta.x/guides/databases',
|
2019-12-06 19:00:00 +01:00
|
|
|
'/3.0.0-beta.x/guides/draft',
|
2019-10-24 15:08:42 +02:00
|
|
|
'/3.0.0-beta.x/guides/error-catching',
|
2019-11-13 18:47:10 +01:00
|
|
|
'/3.0.0-beta.x/guides/external-data',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/guides/jwt-validation',
|
|
|
|
|
'/3.0.0-beta.x/guides/process-manager',
|
2020-01-20 15:44:47 +01:00
|
|
|
'/3.0.0-beta.x/guides/scheduled-publication',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/guides/secure-your-app',
|
2019-12-18 18:17:04 +01:00
|
|
|
'/3.0.0-beta.x/guides/send-email',
|
2020-04-14 11:31:16 +02:00
|
|
|
'/3.0.0-beta.x/guides/registering-a-field-in-admin',
|
2020-04-09 04:39:50 -07:00
|
|
|
'/3.0.0-beta.x/guides/client',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/guides/update-version',
|
2019-05-06 16:17:16 +02:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
2019-11-07 13:53:36 +01:00
|
|
|
title: '⚙️️ Admin Panel',
|
2020-04-15 13:03:21 +02:00
|
|
|
children: [
|
|
|
|
|
'/3.0.0-beta.x/admin-panel/customization',
|
|
|
|
|
'/3.0.0-beta.x/admin-panel/custom-webpack-config',
|
|
|
|
|
'/3.0.0-beta.x/admin-panel/deploy',
|
|
|
|
|
],
|
2019-05-06 16:17:16 +02:00
|
|
|
},
|
2019-10-03 17:59:56 +02:00
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '📦 Plugins',
|
|
|
|
|
children: [
|
2019-10-07 16:02:15 +02:00
|
|
|
'/3.0.0-beta.x/plugins/documentation',
|
2019-10-07 17:53:33 +02:00
|
|
|
'/3.0.0-beta.x/plugins/email',
|
2019-10-07 17:03:45 +02:00
|
|
|
'/3.0.0-beta.x/plugins/graphql',
|
2020-04-09 04:29:59 -07:00
|
|
|
'/3.0.0-beta.x/plugins/upload',
|
|
|
|
|
'/3.0.0-beta.x/plugins/users-permissions',
|
2019-10-03 17:59:56 +02:00
|
|
|
],
|
|
|
|
|
},
|
2019-05-06 16:17:16 +02:00
|
|
|
{
|
|
|
|
|
collapsable: true,
|
2019-11-07 13:53:36 +01:00
|
|
|
title: '🔌 Local Plugins',
|
2019-05-06 16:17:16 +02:00
|
|
|
children: [
|
2019-05-07 17:00:37 +02:00
|
|
|
'/3.0.0-beta.x/plugin-development/quick-start',
|
|
|
|
|
'/3.0.0-beta.x/plugin-development/plugin-architecture',
|
|
|
|
|
'/3.0.0-beta.x/plugin-development/backend-development',
|
|
|
|
|
'/3.0.0-beta.x/plugin-development/frontend-development',
|
2020-03-05 17:04:42 +01:00
|
|
|
'/3.0.0-beta.x/plugin-development/frontend-field-api',
|
|
|
|
|
'/3.0.0-beta.x/plugin-development/frontend-settings-api',
|
2019-05-06 16:17:16 +02:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
|
|
|
|
title: '💻 Command Line Interface',
|
2019-05-07 17:00:37 +02:00
|
|
|
children: ['/3.0.0-beta.x/cli/CLI'],
|
2019-05-06 16:17:16 +02:00
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: true,
|
2019-10-05 17:58:59 +02:00
|
|
|
title: '🏗 Global strapi',
|
2019-10-09 12:32:58 +02:00
|
|
|
children: [
|
|
|
|
|
'/3.0.0-beta.x/global-strapi/api-reference',
|
|
|
|
|
'/3.0.0-beta.x/global-strapi/usage-information',
|
|
|
|
|
],
|
2019-05-06 16:17:16 +02:00
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
collapsable: false,
|
|
|
|
|
title: '📚 Resources',
|
|
|
|
|
children: [
|
2020-03-04 09:32:13 +01:00
|
|
|
['https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md', 'Contributing guide'],
|
2019-05-07 17:00:37 +02:00
|
|
|
'/3.0.0-beta.x/migration-guide/',
|
2019-05-06 16:17:16 +02:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
],
|
2018-09-28 10:20:08 +02:00
|
|
|
},
|
2018-08-28 11:23:59 +02:00
|
|
|
},
|
2019-02-04 19:45:00 +01:00
|
|
|
};
|
