docs: update dependencies (#6046)

This commit is contained in:
Shahed Nasser
2024-01-10 10:56:54 +02:00
committed by GitHub
parent bc58bc8f47
commit 0b0c25da11
18 changed files with 427 additions and 299 deletions
@@ -5,6 +5,7 @@ import TabItem from "@theme/TabItem"
import { specs } from "../../utils/specs"
import CodeBlock from "../../theme/CodeBlock"
import Mermaid from "@docusaurus/theme-mermaid/lib/theme/Mermaid/index.js"
import Heading from "@theme/Heading"
type WorkflowReferenceProps = {
specName: string
@@ -28,7 +29,7 @@ const Diagram2CodeSpecs = ({ specName }: WorkflowReferenceProps) => {
{!Object.keys(specsData).length && <span>No diagrams found</span>}
{Object.entries(specsData).map(([name, diagram2code]) => (
<React.Fragment key={name}>
<h2>{transformTitle(name)}</h2>
<Heading as="h2">{transformTitle(name)}</Heading>
<Tabs groupId="workflows">
<TabItem
value="diagram"
@@ -4,6 +4,7 @@ import IconGitHub from "@site/src/theme/Icon/GitHub"
import IconDiscord from "@site/src/theme/Icon/Discord"
import IconLinkedIn from "@site/src/theme/Icon/LinkedIn"
import { SocialLink } from "@medusajs/docs"
import Link from "@docusaurus/Link"
type SocialLinksProps = {
links?: SocialLink[]
@@ -28,9 +29,13 @@ const SocialLinks: React.FC<SocialLinksProps> = ({ links = [] }) => {
return (
<div className="flex items-center">
{links.map((link) => (
<a className="group ml-1 first:ml-0" href={link.href} key={link.type}>
<Link
className="group ml-1 first:ml-0"
href={link.href}
key={link.type}
>
{socialIcons[link.type]}
</a>
</Link>
))}
</div>
)
@@ -3,6 +3,7 @@ import { NavbarAction } from "@medusajs/docs"
import Icon from "../../../theme/Icon"
import clsx from "clsx"
import { Button, Tooltip } from "docs-ui"
import Link from "@docusaurus/Link"
type NavbarActionsProps = {
items: NavbarAction[]
@@ -28,7 +29,7 @@ const NavbarActions: React.FC<NavbarActionsProps> = ({
key={index}
tooltipClassName="!text-compact-x-small-plus"
>
<a
<Link
href={item.href}
title={item.title}
className={clsx(
@@ -39,7 +40,7 @@ const NavbarActions: React.FC<NavbarActionsProps> = ({
{item.label}
{ItemIconElm}
{ItemIcon && <ItemIcon />}
</a>
</Link>
</Tooltip>
)
case "button":
@@ -60,7 +61,7 @@ const NavbarActions: React.FC<NavbarActionsProps> = ({
{ItemIconElm}
{ItemIcon && <ItemIcon />}
{item.href && (
<a
<Link
href={item.href}
className="absolute top-0 left-0 w-full h-full"
/>
@@ -1,5 +1,4 @@
import { exec } from "child_process"
import { Dirent } from "fs"
import { readdir, readFile, writeFile } from "fs/promises"
import path from "path"
@@ -7,6 +7,7 @@ import AnnouncementBarContent from "@theme/AnnouncementBar/Content"
import clsx from "clsx"
import { Bordered } from "docs-ui"
import { BellAlertSolid } from "@medusajs/icons"
import Link from "@docusaurus/Link"
export default function AnnouncementBar(): JSX.Element | null {
const { announcementBar } = useThemeConfig()
@@ -42,7 +43,7 @@ export default function AnnouncementBar(): JSX.Element | null {
className={clsx("z-[101] text-right lg:basis-[50px]")}
/>
)}
<a
<Link
href={id}
className={clsx("absolute top-0 left-0 w-full h-full z-[100]")}
/>
@@ -16,6 +16,7 @@ import { Tooltip, CopyButton } from "docs-ui"
import useIsBrowser from "@docusaurus/useIsBrowser"
import { ThemeConfig } from "@medusajs/docs"
import { ExclamationCircleSolid, SquareTwoStackSolid } from "@medusajs/icons"
import Link from "@docusaurus/Link"
// Prism languages are always lowercase
// We want to fail-safe and allow both "php" and "PHP"
@@ -114,7 +115,7 @@ export default function CodeBlockString({
>
{!noReport && (
<Tooltip text="Report Incorrect Code">
<a
<Link
href={`${reportCodeLinkPrefix}&title=${encodeURIComponent(
`Docs(Code Issue): Code Issue in ${
isBrowser ? location.pathname : ""
@@ -129,7 +130,7 @@ export default function CodeBlockString({
rel="noreferrer"
>
<ExclamationCircleSolid className="text-medusa-code-icon" />
</a>
</Link>
</Tooltip>
)}
{!noCopy && (
@@ -4,11 +4,12 @@ import { ThemeClassNames } from "@docusaurus/theme-common"
import type { Props } from "@theme/EditThisPage"
import { Button } from "docs-ui"
import clsx from "clsx"
import Link from "@docusaurus/Link"
export default function EditThisPage({ editUrl }: Props): JSX.Element {
return (
<Button variant="secondary">
<a
<Link
href={editUrl}
target="_blank"
rel="noreferrer noopener"
@@ -20,7 +21,7 @@ export default function EditThisPage({ editUrl }: Props): JSX.Element {
>
Edit this page
</Translate>
</a>
</Link>
</Button>
)
}
@@ -3,6 +3,8 @@ import clsx from "clsx"
import Translate from "@docusaurus/Translate"
import type { Props } from "@theme/NotFound/Content"
import useBaseUrl from "@docusaurus/useBaseUrl"
import Heading from "@theme/Heading"
import Link from "@docusaurus/Link"
export default function NotFoundContent({ className }: Props): JSX.Element {
return (
@@ -11,14 +13,14 @@ export default function NotFoundContent({ className }: Props): JSX.Element {
>
<div className="row">
<div className="col col--6 col--offset-3">
<h1>
<Heading as="h1">
<Translate
id="theme.NotFound.title"
description="The title of the 404 page"
>
Page Not Found
</Translate>
</h1>
</Heading>
<p>
<Translate
id="theme.NotFound.p1"
@@ -31,41 +33,43 @@ export default function NotFoundContent({ className }: Props): JSX.Element {
</p>
<p>
If you think this is a mistake, please{" "}
<a
<Link
href="https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml"
rel="noopener noreferrer"
target="_blank"
>
report this issue on GitHub
</a>
</Link>
</p>
<h2>Some popular links</h2>
<Heading as="h2">Some popular links</Heading>
<ul>
<li>
<a href={useBaseUrl("/usage/create-medusa-app")}>
<Link href={useBaseUrl("/create-medusa-app")}>
Install Medusa with create-medusa-app
</a>
</Link>
</li>
<li>
<a href="https://docs.medusajs.com/api/store">
<Link href="https://docs.medusajs.com/api/store">
Storefront REST API Reference
</a>
</Link>
</li>
<li>
<a href="https://docs.medusajs.com/api/admin">
<Link href="https://docs.medusajs.com/api/admin">
Admin REST API Reference
</a>
</Link>
</li>
<li>
<a href={useBaseUrl("/starters/nextjs-medusa-starter")}>
<Link href={useBaseUrl("/starters/nextjs-medusa-starter")}>
Install Next.js Storefront
</a>
</Link>
</li>
<li>
<a href={useBaseUrl("/admin/quickstart")}>Install Medusa Admin</a>
<Link href={useBaseUrl("/admin/quickstart")}>
Install Medusa Admin
</Link>
</li>
<li>
<a href={useBaseUrl("/user-guide")}>User Guide</a>
<Link href={useBaseUrl("/user-guide")}>User Guide</Link>
</li>
</ul>
</div>
-2
View File
@@ -26,8 +26,6 @@ declare module "@medusajs/docs" {
PropSidebarItemCategory,
PropSidebarItemLink,
PropSidebarItemHtml,
SidebarCategoriesShorthand,
SidebarItemConfig,
} from "@docusaurus/plugin-content-docs"
import { BadgeProps, ButtonType, ButtonVariants } from "docs-ui"
import { IconProps } from "@medusajs/icons/dist/types"