/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
const icon = {
bolt: ``,
angleBrackets: ``,
puzzle: ``,
book: ``,
computer: ``,
shoppingBag: ``,
academicCap: ``,
cloudArrowUp: ``,
tsLogo: ``,
graphqlLogo: ``,
};
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
learnSidebar: [
{
type: 'category',
label: 'Getting Started',
items: ['guides/getting-started/installation/index', 'guides/getting-started/first-steps/index'],
customProps: {
icon: icon.bolt,
},
},
{
type: 'category',
label: 'Developer Guide',
items: [
'guides/developer-guide/overview/index',
'guides/developer-guide/configuration/index',
'guides/developer-guide/the-api-layer/index',
'guides/developer-guide/the-service-layer/index',
'guides/developer-guide/custom-fields/index',
'guides/developer-guide/strategies-configurable-operations/index',
'guides/developer-guide/worker-job-queue/index',
'guides/developer-guide/plugins/index',
'guides/developer-guide/migrations/index',
],
customProps: {
icon: icon.angleBrackets,
},
},
{
type: 'category',
label: 'Core Concepts',
items: [{ type: 'autogenerated', dirName: 'guides/core-concepts' }],
customProps: {
icon: icon.puzzle,
},
},
{
type: 'category',
label: 'How-to Guides',
items: [{ type: 'autogenerated', dirName: 'guides/how-to' }],
customProps: {
icon: icon.book,
},
},
{
type: 'category',
label: 'Extending the Admin UI',
items: [{ type: 'autogenerated', dirName: 'guides/extending-the-admin-ui' }],
customProps: {
icon: icon.computer,
},
},
{
type: 'category',
label: 'Building a Storefront',
items: [{ type: 'autogenerated', dirName: 'guides/storefront' }],
customProps: {
icon: icon.shoppingBag,
},
},
{
type: 'category',
label: 'Advanced Topics',
items: [{ type: 'autogenerated', dirName: 'guides/advanced-topics' }],
customProps: {
icon: icon.academicCap,
},
},
{
type: 'category',
label: 'Deployment',
items: [{ type: 'autogenerated', dirName: 'guides/deployment' }],
customProps: {
icon: icon.cloudArrowUp,
},
},
],
referenceSidebar: [
{
type: 'doc',
id: 'reference/index',
className: 'reference-index',
},
{
type: 'category',
label: 'TypeScript API',
items: [{ type: 'autogenerated', dirName: 'reference/typescript-api' }],
customProps: {
viewBox: '0 0 128 128',
icon: icon.tsLogo,
},
},
{
type: 'category',
label: 'GraphQL API',
items: [
{
type: 'category',
label: 'Admin API',
items: [{ type: 'autogenerated', dirName: 'reference/graphql-api/admin' }],
},
{
type: 'category',
label: 'Shop API',
items: [{ type: 'autogenerated', dirName: 'reference/graphql-api/shop' }],
},
],
customProps: {
viewBox: '0 0 100 100',
icon: icon.graphqlLogo,
},
},
{
type: 'category',
label: 'Admin UI API',
items: [{ type: 'autogenerated', dirName: 'reference/admin-ui-api' }],
customProps: {
icon: icon.computer,
},
},
],
};
module.exports = sidebars;