docs: redesign table of content (#12647)

* implement toc

* added to projects

* fixes and adapt for references

* added product frontmatter

* remove action menu from 404 pages
This commit is contained in:
Shahed Nasser
2025-05-30 16:55:36 +03:00
committed by GitHub
parent 490bd7647f
commit 009d00f27d
293 changed files with 1975 additions and 506 deletions
@@ -4,6 +4,8 @@ sidebar_label: "Manage Customer Groups"
tags:
- user guide
- customer
products:
- customer
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Customers"
tags:
- user guide
- customer
products:
- customer
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Customers Overview"
tags:
- user guide
- customer
products:
- customer
---
export const metadata = {
@@ -4,6 +4,8 @@ sidebar_label: "Manage Inventory Items"
tags:
- user guide
- inventory
products:
- inventory
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Inventory Overview"
tags:
- user guide
- inventory
products:
- inventory
---
export const metadata = {
@@ -4,6 +4,8 @@ sidebar_label: "Manage Reservations"
tags:
- user guide
- inventory
products:
- inventory
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
+5 -1
View File
@@ -1,3 +1,7 @@
---
hide_content_menu: true
---
import { CardList, H1 } from "docs-ui"
import {
BookOpen,
@@ -10,7 +14,7 @@ export const metadata = {
title: `Page Not Found`,
}
<H1 hideLlmDropdown>{metadata.title}</H1>
# {metadata.title}
The page you were looking for isn't available.
@@ -4,6 +4,8 @@ sidebar_label: "Manage Order Claims"
tags:
- user guide
- order
products:
- order
---
import {
@@ -4,6 +4,8 @@ sidebar_label: "Edit Order Items"
tags:
- user guide
- order
products:
- order
---
import {
@@ -4,6 +4,8 @@ sidebar_label: "Manage Order Exchanges"
tags:
- user guide
- order
products:
- order
---
import {
@@ -5,6 +5,9 @@ tags:
- user guide
- order
- fulfillment
products:
- order
- fulfillment
---
import {
@@ -4,6 +4,8 @@ sidebar_label: "Manage Order Details"
tags:
- user guide
- order
products:
- order
---
import {
+2
View File
@@ -4,6 +4,8 @@ sidebar_label: "Orders Overview"
tags:
- user guide
- order
products:
- order
---
export const metadata = {
@@ -5,6 +5,9 @@ tags:
- user guide
- order
- payment
products:
- order
- payment
---
import {
@@ -4,6 +4,8 @@ sidebar_label: "Manage Order Returns"
tags:
- user guide
- order
products:
- order
---
import {
@@ -4,6 +4,8 @@ sidebar_label: "Create a Price List"
tags:
- user guide
- pricing
products:
- pricing
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Price Lists"
tags:
- user guide
- pricing
products:
- pricing
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Price Lists Overview"
tags:
- user guide
- pricing
products:
- pricing
---
export const metadata = {
@@ -4,6 +4,8 @@ sidebar_label: "Manage Product Categories"
tags:
- user guide
- product
products:
- product
---
import { DotsSix, TriangleRightMini, EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Product Collections"
tags:
- user guide
- product
products:
- product
---
import { EllipsisHorizontal,ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -3,6 +3,9 @@ sidebar_label: "Create Bundle Product"
tags:
- user guide
- product
products:
- product
- inventory
---
export const metadata = {
@@ -3,6 +3,9 @@ sidebar_label: "Create Multi-Part Product"
tags:
- user guide
- product
products:
- product
- inventory
---
export const metadata = {
@@ -4,6 +4,8 @@ sidebar_label: "Create Product"
tags:
- user guide
- product
products:
- product
---
import { DotsSix, EllipsisHorizontal, XMark, TaxExclusive, TaxInclusive } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Edit Product"
tags:
- user guide
- product
products:
- product
---
import { ArrowUpRightOnBox, EllipsisHorizontal, EllipsisVertical, ThumbnailBadge } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Export Products"
tags:
- user guide
- product
products:
- product
---
import { BellAlert, ArrowDownTray } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Import Products"
tags:
- user guide
- product
products:
- product
---
import { ArrowDownTray, Trash, BellAlert, EllipsisHorizontal } from "@medusajs/icons"
@@ -3,6 +3,8 @@ sidebar_label: "Products Overview"
tags:
- user guide
- product
products:
- product
---
export const metadata = {
@@ -4,6 +4,8 @@ sidebar_label: "Manage Product Variants"
tags:
- user guide
- product
products:
- product
---
import { EllipsisVertical, TaxExclusive, TaxInclusive, ArrowUpRightOnBox } from "@medusajs/icons"
@@ -3,6 +3,8 @@ sidebar_label: "Manage Campaigns"
tags:
- user guide
- promotion
products:
- promotion
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Create a Promotion"
tags:
- user guide
- promotion
products:
- promotion
---
export const metadata = {
@@ -4,6 +4,8 @@ sidebar_label: "Manage Promotions"
tags:
- user guide
- promotion
products:
- promotion
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Promotions Overview"
tags:
- user guide
- promotion
products:
- promotion
---
export const metadata = {
@@ -4,6 +4,9 @@ tags:
- user guide
- user
- auth
products:
- user
- auth
---
export const metadata = {
@@ -3,6 +3,8 @@ sidebar_label: "Manage Publishable API Keys"
tags:
- user guide
- api key
products:
- api key
---
import { Table } from "docs-ui"
@@ -3,6 +3,8 @@ sidebar_label: "Manage Secret API Keys"
tags:
- user guide
- api key
products:
- api key
---
import { Table } from "docs-ui"
@@ -7,6 +7,9 @@ tags:
label: "Manage Locations"
- name: fulfillment
label: "Manage Shipping Options"
products:
- stock location
- fulfillment
---
import { EllipsisHorizontal, TaxExclusive, TaxInclusive, ArrowsPointingOut, Plus } from "@medusajs/icons"
@@ -4,6 +4,9 @@ tags:
- user guide
- stock location
- fulfillment
products:
- stock location
- fulfillment
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -3,6 +3,8 @@ sidebar_label: "Manage Shipping Profiles"
tags:
- user guide
- fulfillment
products:
- fulfillment
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -3,6 +3,8 @@ sidebar_label: "Manage Product Tags"
tags:
- user guide
- product
products:
- product
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -3,6 +3,8 @@ sidebar_label: "Manage Product Types"
tags:
- user guide
- product
products:
- product
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Profile"
tags:
- user guide
- user
products:
- user
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Regions"
tags:
- user guide
- region
products:
- region
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Return Reasons"
tags:
- user guide
- order
products:
- order
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Sales Channels"
tags:
- user guide
- sales channel
products:
- sales channel
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -5,6 +5,8 @@ tags:
- user guide
- store
- currency
products:
- currency
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Tax Regions"
tags:
- user guide
- tax
products:
- tax
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Invites"
tags:
- user guide
- user
products:
- user
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -4,6 +4,8 @@ sidebar_label: "Manage Users"
tags:
- user guide
- user
products:
- user
---
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
+8
View File
@@ -1,6 +1,7 @@
import { DocsConfig, Sidebar } from "types"
import { generatedSidebars } from "@/generated/sidebar.mjs"
import { globalConfig } from "docs-ui"
import { basePathUrl } from "../utils/base-path-url"
const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000"
@@ -23,4 +24,11 @@ export const config: DocsConfig = {
},
],
},
version: {
...globalConfig.version,
bannerImage: {
light: basePathUrl("/images/get-started-card.png"),
dark: basePathUrl("/images/get-started-card-dark.png"),
},
},
}
+47 -47
View File
@@ -2,58 +2,58 @@ export const generatedEditDates = {
"app/tips/languages/page.mdx": "2025-04-11T09:14:21.012Z",
"app/tips/bulk-editor/page.mdx": "2025-04-07T13:20:09.040Z",
"app/tips/lists/page.mdx": "2025-02-14T14:16:04.867Z",
"app/settings/sales-channels/page.mdx": "2025-02-19T17:33:55.584Z",
"app/settings/users/page.mdx": "2025-02-19T11:34:00.736Z",
"app/settings/sales-channels/page.mdx": "2025-05-30T13:31:09.754Z",
"app/settings/users/page.mdx": "2025-05-30T13:31:29.991Z",
"app/page.mdx": "2025-02-26T14:18:27.755Z",
"app/settings/page.mdx": "2025-02-19T15:46:09.018Z",
"app/products/export/page.mdx": "2025-02-18T12:16:52.639Z",
"app/settings/return-reasons/page.mdx": "2025-02-19T17:34:01.942Z",
"app/settings/regions/page.mdx": "2025-02-19T17:37:17.896Z",
"app/orders/page.mdx": "2025-02-17T15:13:42.484Z",
"app/settings/users/invites/page.mdx": "2025-02-19T11:38:54.009Z",
"app/products/export/page.mdx": "2025-05-30T13:29:35.117Z",
"app/settings/return-reasons/page.mdx": "2025-05-30T13:31:05.596Z",
"app/settings/regions/page.mdx": "2025-05-30T13:30:59.228Z",
"app/orders/page.mdx": "2025-05-30T13:28:32.793Z",
"app/settings/users/invites/page.mdx": "2025-05-30T13:31:25.855Z",
"app/settings/developer/page.mdx": "2025-02-25T15:11:55.392Z",
"app/settings/profile/page.mdx": "2025-03-06T08:49:28.814Z",
"app/settings/store/page.mdx": "2025-02-26T10:33:07.346Z",
"app/products/import/page.mdx": "2025-05-06T16:14:03.721Z",
"app/products/categories/page.mdx": "2025-02-19T10:21:42.058Z",
"app/inventory/reservations/page.mdx": "2025-02-18T13:56:28.134Z",
"app/settings/profile/page.mdx": "2025-05-30T13:30:55.079Z",
"app/settings/store/page.mdx": "2025-05-30T13:31:17.095Z",
"app/products/import/page.mdx": "2025-05-30T13:29:40.194Z",
"app/products/categories/page.mdx": "2025-05-30T13:28:59.821Z",
"app/inventory/reservations/page.mdx": "2025-05-30T13:27:25.559Z",
"app/discounts/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/page.mdx": "2025-02-18T12:24:19.794Z",
"app/inventory/inventory/page.mdx": "2025-02-18T13:59:16.960Z",
"app/customers/groups/page.mdx": "2025-02-18T15:41:30.730Z",
"app/orders/manage/page.mdx": "2025-02-18T15:38:17.544Z",
"app/orders/returns/page.mdx": "2025-02-17T15:10:11.039Z",
"app/inventory/page.mdx": "2025-02-18T13:58:42.393Z",
"app/orders/claims/page.mdx": "2025-02-17T15:16:27.380Z",
"app/orders/fulfillments/page.mdx": "2025-02-25T15:02:02.160Z",
"app/customers/page.mdx": "2025-02-18T15:38:17.543Z",
"app/orders/edit/page.mdx": "2025-02-17T15:15:53.489Z",
"app/products/collections/page.mdx": "2025-02-18T14:00:51.469Z",
"app/customers/manage/page.mdx": "2025-04-11T09:30:20.738Z",
"app/products/page.mdx": "2025-05-30T13:29:49.292Z",
"app/inventory/inventory/page.mdx": "2025-05-30T13:27:17.017Z",
"app/customers/groups/page.mdx": "2025-05-30T13:26:56.820Z",
"app/orders/manage/page.mdx": "2025-05-30T13:28:15.271Z",
"app/orders/returns/page.mdx": "2025-05-30T13:28:28.116Z",
"app/inventory/page.mdx": "2025-05-30T13:27:31.179Z",
"app/orders/claims/page.mdx": "2025-05-30T13:27:39.540Z",
"app/orders/fulfillments/page.mdx": "2025-05-30T13:28:08.998Z",
"app/customers/page.mdx": "2025-05-30T13:27:11.744Z",
"app/orders/edit/page.mdx": "2025-05-30T13:27:51.495Z",
"app/products/collections/page.mdx": "2025-05-30T13:29:05.948Z",
"app/customers/manage/page.mdx": "2025-05-30T13:27:02.851Z",
"app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z",
"app/orders/payments/page.mdx": "2025-05-30T13:28:21.451Z",
"app/discounts/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/exchanges/page.mdx": "2025-02-17T15:14:13.676Z",
"app/products/create/page.mdx": "2025-02-25T15:02:02.160Z",
"app/products/edit/page.mdx": "2025-02-19T10:18:34.689Z",
"app/products/variants/page.mdx": "2025-02-19T12:45:06.674Z",
"app/products/create/bundle/page.mdx": "2025-02-18T12:17:32.166Z",
"app/products/create/multi-part/page.mdx": "2025-02-18T12:17:29.629Z",
"app/promotions/campaigns/page.mdx": "2025-02-19T09:02:49.193Z",
"app/promotions/create/page.mdx": "2025-02-19T10:13:44.835Z",
"app/promotions/manage/page.mdx": "2025-02-19T09:01:11.841Z",
"app/promotions/page.mdx": "2025-02-19T09:00:12.501Z",
"app/price-lists/create/page.mdx": "2025-02-19T10:11:33.113Z",
"app/price-lists/manage/page.mdx": "2025-02-19T10:35:49.881Z",
"app/price-lists/page.mdx": "2025-02-19T09:51:32.546Z",
"app/settings/tax-regions/page.mdx": "2025-05-09T13:58:40.440Z",
"app/settings/locations-and-shipping/locations/page.mdx": "2025-04-17T13:47:40.883Z",
"app/settings/locations-and-shipping/page.mdx": "2025-02-19T17:23:45.824Z",
"app/settings/locations-and-shipping/shipping-profiles/page.mdx": "2025-02-19T17:36:46.339Z",
"app/settings/product-tags/page.mdx": "2025-02-19T17:36:25.102Z",
"app/settings/product-types/page.mdx": "2025-02-19T17:36:16.496Z",
"app/settings/developer/publishable-api-keys/page.mdx": "2025-02-25T16:15:29.847Z",
"app/settings/developer/secret-api-keys/page.mdx": "2025-02-25T16:17:40.621Z",
"app/orders/exchanges/page.mdx": "2025-05-30T13:27:55.646Z",
"app/products/create/page.mdx": "2025-05-30T13:29:24.876Z",
"app/products/edit/page.mdx": "2025-05-30T13:29:29.625Z",
"app/products/variants/page.mdx": "2025-05-30T13:29:45.049Z",
"app/products/create/bundle/page.mdx": "2025-05-30T13:29:15.958Z",
"app/products/create/multi-part/page.mdx": "2025-05-30T13:29:20.321Z",
"app/promotions/campaigns/page.mdx": "2025-05-30T13:29:54.241Z",
"app/promotions/create/page.mdx": "2025-05-30T13:29:58.799Z",
"app/promotions/manage/page.mdx": "2025-05-30T13:30:02.678Z",
"app/promotions/page.mdx": "2025-05-30T13:30:08.538Z",
"app/price-lists/create/page.mdx": "2025-05-30T13:28:41.126Z",
"app/price-lists/manage/page.mdx": "2025-05-30T13:28:47.929Z",
"app/price-lists/page.mdx": "2025-05-30T13:28:53.668Z",
"app/settings/tax-regions/page.mdx": "2025-05-30T13:31:21.021Z",
"app/settings/locations-and-shipping/locations/page.mdx": "2025-05-30T13:30:33.160Z",
"app/settings/locations-and-shipping/page.mdx": "2025-05-30T13:30:41.759Z",
"app/settings/locations-and-shipping/shipping-profiles/page.mdx": "2025-05-30T13:30:37.452Z",
"app/settings/product-tags/page.mdx": "2025-05-30T13:30:46.705Z",
"app/settings/product-types/page.mdx": "2025-05-30T13:30:50.623Z",
"app/settings/developer/publishable-api-keys/page.mdx": "2025-05-30T13:30:19.734Z",
"app/settings/developer/secret-api-keys/page.mdx": "2025-05-30T13:30:23.919Z",
"app/settings/developer/workflows/page.mdx": "2025-02-25T15:52:48.349Z",
"app/reset-password/page.mdx": "2025-04-17T08:29:28.890Z"
"app/reset-password/page.mdx": "2025-05-30T13:30:13.055Z"
}
+6
View File
@@ -11,8 +11,11 @@ import {
resolveAdmonitionsPlugin,
crossProjectLinksPlugin,
prerequisitesLinkFixerPlugin,
remarkAttachFrontmatterDataPlugin,
recmaInjectMdxDataPlugin,
} from "remark-rehype-plugins"
import bundleAnalyzer from "@next/bundle-analyzer"
import withExtractedTableOfContents from "@stefanprobst/rehype-extract-toc"
const withMDX = mdx({
extension: /\.mdx?$/,
@@ -92,12 +95,15 @@ const withMDX = mdx({
checkLinksType: "value",
},
],
[withExtractedTableOfContents],
],
remarkPlugins: [
[remarkFrontmatter],
[remarkDirective],
[resolveAdmonitionsPlugin],
[remarkAttachFrontmatterDataPlugin],
],
recmaPlugins: [[recmaInjectMdxDataPlugin]],
jsx: true,
},
})
+1
View File
@@ -18,6 +18,7 @@
"@mdx-js/react": "^3.1.0",
"@medusajs/icons": "2.8.3",
"@next/mdx": "15.0.4",
"@stefanprobst/rehype-extract-toc": "^3.0.0",
"clsx": "^2.1.0",
"docs-ui": "*",
"next": "15.0.4",
Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB