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
+14 -794
View File
@@ -1,809 +1,29 @@
import coreConfig from "../tailwind.config"
/** @type {import('tailwindcss').Config} */
module.exports = {
prefix: "tw-",
...coreConfig,
// prefix: "tw-",
corePlugins: {
preflight: false, // disable Tailwind's reset
},
content: ["./src/**/*.{js,jsx,ts,tsx}", "../../docs/content/**/*.{mdx,md}"],
darkMode: ["class", `[data-theme="dark"]`], // hooks into docusaurus' dark mode settigns
content: [
"./src/**/*.{js,jsx,ts,tsx}",
"../../docs/content/**/*.{mdx,md}",
"docusaurus.config.js",
"sidebars.js",
],
theme: {
...coreConfig.theme,
extend: {
colors: {
white: "#FFFFFF",
gray: {
50: "#F8F9FA",
100: "#F1F3F5",
200: "#ECEEF0",
300: "#ECEDEE",
400: "#E6E8EB",
500: "#DFE3E6",
600: "#C1C8CD",
700: "#889096",
800: "#787F85",
900: "#687076",
},
black: {
50: "#697177",
100: "#3A3F42",
200: "#2B2F31",
300: "#202425",
400: "#28282C",
500: "#26292B",
600: "#151718",
700: "#1C1C1F",
800: "#11181C",
900: "#1A1D1E",
},
green: {
50: "#DDF3E4",
100: "#CCEBD7",
200: "#B4DFC4",
300: "#4CC38A",
400: "#30A46C",
500: "#18794E",
600: "#164430",
700: "#133929",
800: "#113123",
},
blue: {
50: "#E1F0FF",
100: "#CEE7FE",
200: "#B7D9F8",
300: "#52A9FF",
400: "#0091FF",
500: "#006ADC",
600: "#0D3868",
700: "#0F3058",
800: "#102A4C",
},
purple: {
50: "#EDE9FE",
100: "#E4DEFC",
200: "#D7CFF9",
300: "#9E8CFC",
400: "#7C66DC",
500: "#6E56CF",
600: "#644FC1",
700: "#5746AF",
800: "#5842C3",
900: "#392C72",
},
orange: {
50: "#FFECBC",
100: "#FFE3A2",
200: "#FFD386",
300: "#FFB224",
400: "#F1A10D",
500: "#AD5700",
600: "#573300",
700: "#4A2900",
800: "#3F2200",
},
red: {
50: "#FFE5E5",
100: "#FDD8D8",
200: "#F9C6C6",
300: "#FF6369",
400: "#F2555A",
500: "#E5484D",
600: "#DC3D43",
700: "#CD2B31",
800: "#AA2429",
900: "#671E22",
},
pink: {
50: "#FCE5F3",
100: "#F9D8EC",
200: "#F3C6E2",
300: "#F65CB6",
400: "#D6409F",
500: "#CD1D8D",
600: "#601D48",
700: "#501B3F",
800: "#451A37",
},
/* docs colors */
medusa: {
bg: {
subtle: {
DEFAULT: "#F8F9FA",
dark: "#161618",
hover: {
DEFAULT: "#F1F3F5",
dark: "#1C1C1F",
},
pressed: {
DEFAULT: "#ECEEF0",
dark: "#232326",
},
},
base: {
DEFAULT: "#FFFFFF",
dark: "#1C1C1F",
hover: {
DEFAULT: "#F8F9FA",
dark: "#232326",
},
pressed: {
DEFAULT: "#F1F3F5",
dark: "#28282C",
},
},
component: {
DEFAULT: "#F1F3F5",
dark: "#2E2E32",
},
field: {
DEFAULT: "#F8F9FA",
dark: "#232326",
hover: {
DEFAULT: "#F1F3F5",
dark: "#28282C",
},
},
highlight: {
DEFAULT: "#E1F0FF",
dark: "#102A4C",
},
"toggle-off": {
DEFAULT: "#E6E8EB",
dark: "#3E3E44",
},
overlay: {
DEFAULT: "rgba(17, 24, 28, 0.4)",
dark: "rgba(22, 22, 24, 0.7)",
},
interactive: {
DEFAULT: "#0081F1",
dark: "#6E56CF",
},
},
border: {
base: {
DEFAULT: "#E6E8EB",
dark: "#2E2E32",
},
strong: {
DEFAULT: "#D7DBDF",
dark: "#3E3E44",
},
focus: {
DEFAULT: "#0081F1",
dark: "#6E56CF",
inset: {
DEFAULT: "#FFFFFF",
dark: "#1C1C1F",
},
},
interactive: {
DEFAULT: "#0081F1",
dark: "#6E56CF",
},
error: {
DEFAULT: "#E5484D",
dark: "#E5484D",
},
"neutral-buttons": {
DEFAULT: "rgba(17, 24, 28, 0.16)",
dark: "rgba(255, 255, 255, 0.06)",
},
"colored-buttons": {
DEFAULT: "rgba(17, 24, 28, 0.35)",
dark: "rgba(0, 0, 0, 0.24)",
},
},
text: {
base: {
DEFAULT: "#11181C",
dark: "#EDEDEF",
},
subtle: {
DEFAULT: "#687076",
dark: "#7E7D86",
},
muted: {
DEFAULT: "#889096",
dark: "#706F78",
},
disabled: {
DEFAULT: "#C1C8CD",
dark: "#504F57",
},
"on-color": {
DEFAULT: "#FFFFFF",
dark: "#FFFFFF",
},
interactive: {
DEFAULT: "#0081F1",
dark: "#7C66DC",
hover: {
DEFAULT: "#006ADC",
dark: "#9E8CFC",
},
},
error: {
DEFAULT: "#E5484D",
dark: "#E5484D",
},
"on-inverted": {
DEFAULT: "#FFFFFF",
dark: "#1A1523",
},
},
icon: {
base: {
DEFAULT: "#11181C",
dark: "#EDEDEF",
},
subtle: {
DEFAULT: "#687076",
dark: "#7E7D86",
},
muted: {
DEFAULT: "#889096",
dark: "#706F78",
},
disabled: {
DEFAULT: "#C1C8CD",
dark: "#504F57",
},
"on-color": {
DEFAULT: "#FFFFFF",
dark: "#FFFFFF",
},
interactive: {
DEFAULT: "#0081F1",
dark: "#7C66DC",
hover: {
DEFAULT: "#006ADC",
dark: "#9E8CFC",
},
},
error: {
DEFAULT: "#E5484D",
dark: "#E5484D",
},
"on-inverted": {
DEFAULT: "#FFFFFF",
dark: "#1A1523",
},
},
button: {
brand: {
DEFAULT: "#5746AF",
dark: "#5842C3",
hover: {
DEFAULT: "#644FC1",
dark: "#5842C3",
},
pressed: {
DEFAULT: "#5746AF",
dark: "#7C66DC",
},
},
neutral: {
DEFAULT: "#F8F9FA",
dark: "#28282C",
hover: {
DEFAULT: "#F8F9FA",
dark: "#2E2E32",
},
pressed: {
DEFAULT: "#F1F3F5",
dark: "#34343A",
},
},
inverted: {
DEFAULT: "#151718",
dark: "#F4F2F4",
hover: {
DEFAULT: "#202425",
dark: "#F4F2F4",
},
pressed: {
DEFAULT: "#26292B",
dark: "#EEEDEF",
},
},
transparent: {
DEFAULT: "rgba(255, 255, 255, 0)",
dark: "rgba(0, 0, 0, 0)",
hover: {
DEFAULT: "#F8F9FA",
dark: "#2E2E32",
},
pressed: {
DEFAULT: "#F1F3F5",
dark: "#2E2E32",
},
},
danger: {
DEFAULT: "#E5484D",
dark: "#AA2429",
hover: {
DEFAULT: "#DC3D43",
dark: "#AA2429",
},
pressed: {
DEFAULT: "#CD2B31",
dark: "#E5484D",
},
},
disabled: {
DEFAULT: "#ECEEF0",
dark: "#28282C",
},
success: {
DEFAULT: "#30A46C",
dark: "#30A46C",
},
},
tag: {
neutral: {
bg: {
DEFAULT: "#F1F3F5",
dark: "#28282C",
hover: {
DEFAULT: "#ECEEF0",
dark: "#2E2E32",
},
},
text: {
DEFAULT: "#687076",
dark: "#A09FA6",
},
icon: {
DEFAULT: "#889096",
dark: "#706F78",
},
border: {
DEFAULT: "#DFE3E6",
dark: "#3E3E44",
},
},
transparent: {
bg: {
DEFAULT: "rgba(255, 255, 255, 0)",
dark: "#1C1C1F",
hover: {
DEFAULT: "#F8F9FA",
dark: "#232326",
},
},
text: {
DEFAULT: "#687076",
dark: "#A09FA6",
},
icon: {
DEFAULT: "#889096",
dark: "#706F78",
},
border: {
DEFAULT: "#DFE3E6",
dark: "#3E3E44",
},
},
purple: {
bg: {
DEFAULT: "#EDE9FE",
dark: "#2C2250",
hover: {
DEFAULT: "#E4DEFC",
dark: "#32275F",
},
},
text: {
DEFAULT: "#5746AF",
dark: "#9E8CFC",
},
icon: {
DEFAULT: "#6E56CF",
dark: "#6E56CF",
},
border: {
DEFAULT: "#D7CFF9",
dark: "#392C72",
},
},
blue: {
bg: {
DEFAULT: "#E1F0FF",
dark: "#102A4C",
hover: {
DEFAULT: "#CEE7FE",
dark: "#0F3058",
},
},
text: {
DEFAULT: "#006ADC",
dark: "#52A9FF",
},
icon: {
DEFAULT: "#0091FF",
dark: "#0091FF",
},
border: {
DEFAULT: "#B7D9F8",
dark: "#0D3868",
},
},
green: {
bg: {
DEFAULT: "#DDF3E4",
dark: "#113123",
hover: {
DEFAULT: "#CCEBD7",
dark: "#133929",
},
},
text: {
DEFAULT: "#18794E",
dark: "#4CC38A",
},
icon: {
DEFAULT: "#30A46C",
dark: "#30A46C",
},
border: {
DEFAULT: "#B4DFC4",
dark: "#164430",
},
},
orange: {
bg: {
DEFAULT: "#FFECBC",
dark: "#3F2200",
hover: {
DEFAULT: "#FFE3A2",
dark: "#4A2900",
},
},
text: {
DEFAULT: "#AD5700",
dark: "#F1A10D",
},
icon: {
DEFAULT: "#FFB224",
dark: "#FFB224",
},
border: {
DEFAULT: "#FFD386",
dark: "#573300",
},
},
red: {
bg: {
DEFAULT: "#FFE5E5",
dark: "#481A1D",
hover: {
DEFAULT: "#FDD8D8",
dark: "#541B1F",
},
},
text: {
DEFAULT: "#CD2B31",
dark: "#FF6369",
},
icon: {
DEFAULT: "#E5484D",
dark: "#E5484D",
},
border: {
DEFAULT: "#F9C6C6",
dark: "#671E22",
},
},
pink: {
bg: {
DEFAULT: "#FCE5F3",
dark: "#451A37",
hover: {
DEFAULT: "#F9D8EC",
dark: "#501B3F",
},
},
text: {
DEFAULT: "#CD1D8D",
dark: "#F65CB6",
},
icon: {
DEFAULT: "#D6409F",
dark: "#D6409F",
},
border: {
DEFAULT: "#F3C6E2",
dark: "#601D48",
},
},
},
code: {
text: {
base: "#ECEDEE",
subtle: "#787F85",
muted: "#697177",
},
icon: "#697177",
block: {
bg: "#151718",
transparent: "transparent",
header: "#1A1D1E",
border: "#2E2E32",
action: "#706F78",
},
tabs: {
bg: "#1A1D1E",
},
tab: {
bg: "#151718",
hover: "rgba(141, 141, 141, 0.16)",
border: "#3A3F42",
text: {
DEFAULT: "#787F85",
active: "#EDEDEF",
},
title: "#787F85",
},
"text-highlight": "#102A4C",
},
support: {
error: {
DEFAULT: "#E5484D",
dark: "#E5484D",
},
warning: {
DEFAULT: "#FFB224",
dark: "#FFB224",
},
success: {
DEFAULT: "#30A46C",
dark: "#30A46C",
},
info: {
DEFAULT: "#0091FF",
dark: "#0091FF",
},
},
},
/* docs defaults */
docs: {
bg: {
DEFAULT: "#FFFFFF",
dark: "#161618",
surface: {
DEFAULT: "#F8F9FA",
dark: "#1C1C1F",
},
},
},
},
boxShadow: {
"card-rest":
"0px 0px 0px 1px rgba(17, 24, 28, 0.08), 0px 1px 2px -1px rgba(17, 24, 28, 0.08), 0px 2px 4px rgba(17, 24, 28, 0.04)",
"card-rest-dark":
"0px 0px 0px 1px rgba(255, 255, 255, 0.1), 0px 1px 2px -1px rgba(255, 255, 255, 0.16), 0px 2px 4px rgba(0, 0, 0, 0.32)",
"card-hover":
"0px 0px 0px 1px rgba(17, 24, 28, 0.08), 0px 1px 2px -1px rgba(17, 24, 28, 0.08), 0px 2px 8px rgba(17, 24, 28, 0.1)",
"card-hover-dark":
"0px 0px 0px 1px rgba(255, 255, 255, 0.1), 0px 1px 2px -1px rgba(255, 255, 255, 0.16), 0px 2px 8px rgba(0, 0, 0, 0.32)",
tooltip:
"0px 0px 0px 1px rgba(17, 24, 28, 0.08), 0px 4px 8px rgba(17, 24, 28, 0.08)",
"tooltip-dark":
"0px 0px 0px 1px rgba(255, 255, 255, 0.1), 0px 4px 8px rgba(0, 0, 0, 0.32)",
flyout:
"0px 0px 0px 1px rgba(17, 24, 28, 0.08), 0px 8px 16px rgba(17, 24, 28, 0.08)",
"flyout-dark":
"0px 0px 0px 1px rgba(255, 255, 255, 0.1), 0px 8px 16px rgba(0, 0, 0, 0.32)",
modal:
"0px 0px 0px 1px rgba(17, 24, 28, 0.08), 0px 16px 32px rgba(17, 24, 28, 0.08), 0px 2px 24px rgba(17, 24, 28, 0.08)",
"modal-dark":
"0px 0px 0px 1px rgba(255, 255, 255, 0.1), 0px 16px 32px rgba(0, 0, 0, 0.32), 0px 2px 24px rgba(0, 0, 0, 0.32)",
focus: "0px 0px 0px 2px #FFFFFF, 0px 0px 0px 4px #0081F1",
"focus-dark": "0px 0px 0px 2px #1C1C1F, 0px 0px 0px 4px #6E56CF",
active: "0px 0px 0px 3px #E1F0FF",
"active-dark": "0px 0px 0px 3px #2C2250",
overlay: "0px 2px 16px rgba(0, 0, 0, 0.08)",
"overlay-dark": "0px 2px 16px rgba(0, 0, 0, 0.32)",
navbar: "0px 1px 0px 0px #E6E8EB",
"navbar-dark": "0px 1px 0px 0px #2E2E32",
},
borderRadius: {
DEFAULT: "8px",
sm: "4px",
},
lineHeight: {
DEFAULT: "24px",
},
backgroundImage: {
"primary-gradient":
"linear-gradient(90deg, rgba(146, 144, 254, 0) 0%, rgba(163, 219, 254, 0.4) 26.04%, #9290FE 53.65%, rgba(197, 145, 255, 0.4) 78.65%, rgba(201, 138, 255, 0) 100%)",
"code-fade": "linear-gradient(90deg, #15171800, #151718 24px)",
"button-neutral":
"linear-gradient(180deg, #FFFFFF 30.1%, #F8F9FA 100%)",
"button-neutral-dark":
"linear-gradient(180deg, #2E2E32 0%, #28282C 32.67%)",
"no-image": "none",
"button-inverted": "linear-gradient(180deg, #26292B 0%, #151718 30.5%)",
"button-inverted-dark":
"linear-gradient(180deg, #FFFFFF 31.33%, #F4F2F4 100%)",
},
...coreConfig.theme.extend,
screens: {
...coreConfig.theme.screens,
xs: "576px",
lg: "992px",
lg: "996px",
xl: "1419px",
xxl: "1440px",
},
transitionTimingFunction: {
ease: "ease",
},
width: {
sidebar: "321px",
"sidebar-hidden": "0px",
"main-content": "1140px",
"main-content-hidden-sidebar": "1440px",
},
height: {
navbar: "57px",
},
maxWidth: {
"main-content": "1140px",
"main-content-hidden-sidebar": "1440px",
xl: "1419px",
},
minWidth: {
xl: "1419px",
},
fontSize: {
"body-regular-plus": [
"14px",
{
lineHeight: "24px",
fontWeight: "500",
},
],
"body-regular": [
"14px",
{
lineHeight: "24px",
fontWeight: "400",
},
],
h1: [
"32px",
{
lineHeight: "44px",
fontWeight: "500",
},
],
h2: [
"24px",
{
lineHeight: "32px",
fontWeight: "500",
},
],
h3: [
"18px",
{
lineHeight: "28px",
fontWeight: "500",
},
],
"label-large-plus": [
"16px",
{
lineHeight: "20px",
fontWeight: "500",
},
],
"label-regular-plus": [
"14px",
{
lineHeight: "20px",
fontWeight: "500",
},
],
"label-regular": [
"14px",
{
lineHeight: "20px",
fontWeight: "400",
},
],
"label-small-plus": [
"13px",
{
lineHeight: "20px",
fontWeight: "500",
},
],
"label-small": [
"13px",
{
lineHeight: "20px",
fontWeight: "400",
},
],
"label-x-small": [
"12px",
{
lineHeight: "20px",
fontWeight: "400",
},
],
"label-x-small-plus": [
"12px",
{
lineHeight: "20px",
fontWeight: "500",
},
],
},
},
fontFamily: {
base: [
"Inter",
"BlinkMacSystemFont",
"-apple-system",
"Segoe UI",
"Roboto",
"Oxygen",
"Ubuntu",
"Cantarell",
"Fira Sans",
"Droid Sans",
"Helvetica Neue",
"Helvetica",
"Arial",
"sans-serif",
],
monospace: [
"Roboto Mono",
"SFMono-Regular",
"Menlo",
"Monaco",
"Consolas",
"Liberation Mono",
"Courier New",
"monospace",
],
},
spacing: {
px: "1px",
0: "0px",
0.4: "7px",
0.5: "8px",
1: "16px",
1.5: "24px",
2: "32px",
3: "48px",
4: "64px",
5: "80px",
6: "96px",
7: "112px",
8: "128px",
},
backgroundImage: {
"large-card": "url('/img/squares-bg-light.svg')",
"large-card-dark": "url('/img/squares-bg.svg')",
"large-card-fade":
"linear-gradient(transparent, url('/img/squares-bg-light.svg'))",
"large-card-fade-dark":
"linear-gradient(transparent, url('/img/squares-bg.svg'))",
"large-card-fade-hover": "linear-gradient(transparent, #1C1C1F)",
"large-card-fade-hover-dark": "linear-gradient(transparent, #232326)",
"announcement-bg": "url('/img/announcement-bg.svg')",
"card-highlighted": "url('/img/small-squares-bg-light.svg')",
"card-highlighted-dark": "url('/img/small-squares-bg.svg')",
"search-hit": "url('/img/search-hit-light.svg')",
"search-hit-dark": "url('/img/search-hit.svg')",
"search-arrow": "url('/img/search-hit-arrow-light.svg')",
"search-arrow-dark": "url('/img/search-hit-arrow.svg')",
"search-no-result": "url('/img/search-no-result-light.svg')",
"search-no-result-dark": "url('/img/search-no-result.svg')",
"magnifying-glass": "url('/static/img/magnifying-glass.svg')",
toc: "url('/img/side-menu-light.svg')",
"toc-dark": "url('/img/side-menu.svg')",
},
},
plugins: [],
}