api-ref: custom API reference (#4770)

* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
This commit is contained in:
Shahed Nasser
2023-08-15 18:07:54 +03:00
committed by GitHub
parent 16249ec280
commit 914d773d3a
3270 changed files with 22075 additions and 192064 deletions
+4 -9
View File
@@ -38,26 +38,21 @@ export default function DocItemContent({ children }: Props): JSX.Element {
<div className={clsx(ThemeClassNames.docs.docMarkdown, "markdown")}>
{syntheticTitle && (
<header
className={clsx(
badge && "md:tw-flex md:tw-items-center md:tw-gap-0.5 tw-mb-2"
)}
className={clsx(badge && "md:flex md:items-center md:gap-0.5 mb-2")}
>
<Heading as="h1" className={clsx(badge && "!tw-mb-0")}>
<Heading as="h1" className={clsx(badge && "!mb-0")}>
{syntheticTitle}
{badge && (
<Badge
variant={badge.variant}
className="md:tw-hidden tw-ml-1 tw-align-middle"
className="md:hidden ml-1 align-middle"
>
{badge.text}
</Badge>
)}
</Heading>
{badge && (
<Badge
variant={badge.variant}
className={clsx("md:tw-block tw-hidden")}
>
<Badge variant={badge.variant} className={clsx("md:block hidden")}>
{badge.text}
</Badge>
)}
+2 -2
View File
@@ -16,10 +16,10 @@ export default function FooterWrapper(props: Props): JSX.Element {
return (
<>
{!metadata.frontMatter?.hide_footer && (
<div className="tw-mt-[42px]">
<div className="mt-[42px]">
<Feedback
{...footerFeedback}
className="tw-border-0 tw-border-t tw-border-solid tw-border-medusa-border-base dark:tw-border-medusa-border-base-dark"
className="border-0 border-t border-solid border-medusa-border-base dark:border-medusa-border-base-dark"
/>
<Footer {...props} />
</div>
+5 -5
View File
@@ -42,18 +42,18 @@ export default function DocItemLayout({ children }: Props): JSX.Element {
const docTOC = useDocTOC()
const sidebarContext = useSidebar()
return (
<div className="row tw-m-0">
<div className="row m-0">
<div
className={clsx(
"col",
"tw-my-0 tw-mx-auto tw-max-w-main-content tw-w-full tw-ml-auto lg:tw-py-0 tw-py-0 tw-px-1",
!docTOC.hidden && "tw-w-9/12",
!sidebarContext?.hiddenSidebarContainer && "!tw-max-w-[720px]"
"my-0 mx-auto max-w-main-content w-full ml-auto lg:py-0 py-0 px-1",
!docTOC.hidden && "w-9/12",
!sidebarContext?.hiddenSidebarContainer && "!max-w-[720px]"
)}
>
<DocVersionBanner />
<div>
<article className={clsx("[&>*:first-child]:tw-mt-0")}>
<article className={clsx("[&>*:first-child]:mt-0")}>
<DocBreadcrumbs />
<DocVersionBadge />
{docTOC.mobile}