docs: added migration guide for Medusa React (#3066)
* docs: added migration guide for Medusa React * docs: fixed vale error
This commit is contained in:
1 parent
296d6e229f
commit
7cafff14b9
22 files changed
+222
-367
No files matched your search
@@ -2,6 +2,7 @@ const path = require("path")
|
||||
const fs = require("fs")
|
||||
const docsPath = path.join(__dirname, "../../docs/content")
|
||||
const apisPath = path.join(__dirname, "../../docs/api")
|
||||
const reverseSidebar = require('./src/utils/reverseSidebar')
|
||||
|
||||
const algoliaAppId = process.env.ALGOLIA_APP_ID || "temp"
|
||||
const algoliaApiKey = process.env.ALGOLIA_API_KEY || "temp"
|
||||
@@ -33,7 +34,7 @@ const config = {
|
||||
apiKey: process.env.SEGMENT_API_KEY || "temp"
|
||||
}
|
||||
],
|
||||
require.resolve("docusaurus-plugin-image-zoom")
|
||||
require.resolve("docusaurus-plugin-image-zoom"),
|
||||
],
|
||||
themeConfig: {
|
||||
image: 'img/docs-banner.jpg',
|
||||
@@ -210,6 +211,10 @@ const config = {
|
||||
],
|
||||
showLastUpdateTime: true,
|
||||
breadcrumbs: false,
|
||||
async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
|
||||
const sidebarItems = await defaultSidebarItemsGenerator(args);
|
||||
return reverseSidebar(sidebarItems);
|
||||
},
|
||||
},
|
||||
theme: {
|
||||
customCss: require.resolve("./src/css/custom.css")
|
||||
|
||||
+29
-1
@@ -84,4 +84,32 @@
|
||||
|
||||
[[redirects]]
|
||||
from = "/guides/checkouts"
|
||||
to = "/advanced/storefront/how-to-implement-checkout-flow"
|
||||
to = "/advanced/storefront/how-to-implement-checkout-flow"
|
||||
|
||||
[[redirects]]
|
||||
from="/advanced/backend/upgrade-guides/1-7-3"
|
||||
to="advanced/backend/upgrade-guides/medusa-core/1-7-3"
|
||||
|
||||
[[redirects]]
|
||||
from="/advanced/backend/upgrade-guides/1-7-1"
|
||||
to="advanced/backend/upgrade-guides/medusa-core/1-7-1"
|
||||
|
||||
[[redirects]]
|
||||
from="/advanced/backend/upgrade-guides/1-7-0"
|
||||
to="advanced/backend/upgrade-guides/medusa-core/1-7-0"
|
||||
|
||||
[[redirects]]
|
||||
from="/advanced/backend/upgrade-guides/1-6-1"
|
||||
to="advanced/backend/upgrade-guides/medusa-core/1-6-1"
|
||||
|
||||
[[redirects]]
|
||||
from="/advanced/backend/upgrade-guides/1-3-8"
|
||||
to="advanced/backend/upgrade-guides/medusa-core/1-3-8"
|
||||
|
||||
[[redirects]]
|
||||
from="/advanced/backend/upgrade-guides/1-3-6"
|
||||
to="advanced/backend/upgrade-guides/medusa-core/1-3-6"
|
||||
|
||||
[[redirects]]
|
||||
from="/advanced/backend/upgrade-guides/1-3-0"
|
||||
to="advanced/backend/upgrade-guides/medusa-core/1-3-0"
|
||||
+25
-35
@@ -183,45 +183,35 @@ module.exports = {
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/1-7-3",
|
||||
label: "v1.7.3"
|
||||
type: "category",
|
||||
label: "Server",
|
||||
items: [
|
||||
{
|
||||
type: 'autogenerated',
|
||||
dirName: 'advanced/backend/upgrade-guides/medusa-core'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/1-7-1",
|
||||
label: "v1.7.1"
|
||||
type: "category",
|
||||
label: "Medusa React",
|
||||
items: [
|
||||
{
|
||||
type: 'autogenerated',
|
||||
dirName: 'advanced/backend/upgrade-guides/medusa-react'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/1-7-0",
|
||||
label: "v1.7.0"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/1-6-1",
|
||||
label: "v1.6.1"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/1-3-8",
|
||||
label: "v1.3.8"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/1-3-6",
|
||||
label: "v1.3.6"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/1-3-0",
|
||||
label: "v1.3.0"
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
id: "advanced/backend/upgrade-guides/admin/admin-vite",
|
||||
label: "Medusa Admin: Vite"
|
||||
},
|
||||
type: "category",
|
||||
label: "Medusa Admin",
|
||||
items: [
|
||||
{
|
||||
type: 'autogenerated',
|
||||
dirName: 'advanced/backend/upgrade-guides/admin'
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
@@ -1,9 +1,28 @@
|
||||
export default function filterListItems (items: any[], pathPattern: string | RegExp) {
|
||||
import { PropSidebarItem, PropSidebarItemLink } from '@docusaurus/plugin-content-docs'
|
||||
|
||||
export default function filterListItems (items: PropSidebarItemLink[], pathPattern: string | RegExp): PropSidebarItemLink[] {
|
||||
console.log(items)
|
||||
if (!items.length) {
|
||||
return items
|
||||
}
|
||||
|
||||
let pattern = new RegExp(pathPattern)
|
||||
|
||||
return items.filter((item) => pattern.test(item.href))
|
||||
return items.filter((item: PropSidebarItemLink) => pattern.test(item.href))
|
||||
}
|
||||
|
||||
/**
|
||||
* Flatting a sidebar list moving items from category
|
||||
* to links
|
||||
*/
|
||||
export function flattenList (items: PropSidebarItem[]): PropSidebarItem[] {
|
||||
const newItems = items.map((item: PropSidebarItem) => {
|
||||
if (item.type !== 'category') {
|
||||
return item
|
||||
}
|
||||
|
||||
return item.items
|
||||
})
|
||||
|
||||
return newItems.flat()
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
module.exports = function reverseSidebarItems(items) {
|
||||
// Reverse items in categories
|
||||
const result = items.map((item) => {
|
||||
if (item.type === 'category' && item.customProps?.sort === 'desc') {
|
||||
return {...item, items: reverseSidebarItems(item.items)};
|
||||
}
|
||||
return item;
|
||||
});
|
||||
return result;
|
||||
}
|
||||
Reference in new issue
Block a user