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
@@ -1,9 +1,6 @@
|
||||
/* eslint-disable @typescript-eslint/no-var-requires */
|
||||
require("dotenv").config()
|
||||
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"
|
||||
@@ -43,7 +40,7 @@ const config = {
|
||||
},
|
||||
],
|
||||
themeConfig: {
|
||||
image: "img/docs-banner.jpg",
|
||||
image: "img/docs-meta.jpg",
|
||||
colorMode: {
|
||||
defaultMode: "light",
|
||||
disableSwitch: false,
|
||||
@@ -55,7 +52,10 @@ const config = {
|
||||
placeholder: "Search docs...",
|
||||
appId: algoliaAppId,
|
||||
contextualSearch: false,
|
||||
externalUrlRegex: "https://medusajs.com",
|
||||
externalUrlRegex: "https://medusajs.com,https://docs.medusajs.com/api/",
|
||||
searchParameters: {
|
||||
tagFilters: "-reference",
|
||||
},
|
||||
},
|
||||
prism: {
|
||||
defaultLanguage: "js",
|
||||
@@ -69,38 +69,40 @@ const config = {
|
||||
hideOnScroll: false,
|
||||
logo: {
|
||||
alt: "Medusa",
|
||||
src: "img/logo.png",
|
||||
srcDark: "img/logo-dark.png",
|
||||
src: "img/logo-icon.png",
|
||||
srcDark: "img/logo-icon-dark.png",
|
||||
width: 20,
|
||||
height: 20,
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: "search",
|
||||
position: "left",
|
||||
},
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "homepage",
|
||||
label: "Docs",
|
||||
position: "right",
|
||||
position: "left",
|
||||
},
|
||||
{
|
||||
type: "docSidebar",
|
||||
sidebarId: "userGuideSidebar",
|
||||
label: "User Guide",
|
||||
position: "right",
|
||||
position: "left",
|
||||
},
|
||||
{
|
||||
href: "/api/store",
|
||||
href: `${process.env.API_URL}/api/store`,
|
||||
label: "Store API",
|
||||
prependBaseUrlToHref: true,
|
||||
target: "_blank",
|
||||
position: "right",
|
||||
position: "left",
|
||||
},
|
||||
{
|
||||
href: "/api/admin",
|
||||
href: `${process.env.API_URL}/api/admin`,
|
||||
label: "Admin API",
|
||||
prependBaseUrlToHref: true,
|
||||
target: "_blank",
|
||||
position: "left",
|
||||
},
|
||||
{
|
||||
type: "search",
|
||||
position: "right",
|
||||
},
|
||||
],
|
||||
@@ -109,10 +111,17 @@ const config = {
|
||||
{
|
||||
type: "link",
|
||||
href: "https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml",
|
||||
title: "Report an Issue",
|
||||
icon: "report",
|
||||
label: "Report an Issue",
|
||||
className: "btn-secondary max-[1014px]:hidden",
|
||||
},
|
||||
],
|
||||
mobileLogo: {
|
||||
alt: "Medusa",
|
||||
src: "img/logo-mobile.png",
|
||||
srcDark: "img/logo-mobile-dark.png",
|
||||
width: 82,
|
||||
height: 20,
|
||||
},
|
||||
footer: {
|
||||
copyright: `© ${new Date().getFullYear()} Medusa, Inc. All rights reserved.`,
|
||||
},
|
||||
@@ -162,8 +171,8 @@ const config = {
|
||||
docs: {
|
||||
sidebarPath: require.resolve("./sidebars.js"),
|
||||
editUrl:
|
||||
"https://github.com/medusajs/medusa/edit/develop/docs/content",
|
||||
path: docsPath,
|
||||
"https://github.com/medusajs/medusa/edit/develop/www/docs/content",
|
||||
path: "content",
|
||||
routeBasePath: "/",
|
||||
remarkPlugins: [
|
||||
[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
|
||||
@@ -184,46 +193,8 @@ const config = {
|
||||
gtag: {
|
||||
trackingID: "G-S7G7X3JYS3",
|
||||
},
|
||||
},
|
||||
],
|
||||
[
|
||||
"redocusaurus",
|
||||
{
|
||||
// Plugin Options for loading OpenAPI files
|
||||
specs: [
|
||||
{
|
||||
spec: path.join(apisPath, "store/openapi.yaml"),
|
||||
route: "/api/store",
|
||||
layout: {
|
||||
noFooter: true,
|
||||
},
|
||||
},
|
||||
{
|
||||
spec: path.join(apisPath, "admin/openapi.yaml"),
|
||||
route: "/api/admin",
|
||||
layout: {
|
||||
noFooter: true,
|
||||
},
|
||||
},
|
||||
],
|
||||
// Theme Options for modifying how redoc renders them
|
||||
theme: {
|
||||
primaryColorDark: "#161618",
|
||||
options: {
|
||||
disableSearch: true,
|
||||
nativeScrollbars: true,
|
||||
sortTagsAlphabetically: true,
|
||||
expandResponses: "200,204",
|
||||
generatedPayloadSamplesMaxDepth: 4,
|
||||
showObjectSchemaExamples: true,
|
||||
requiredPropsFirst: true,
|
||||
hideRequestPayloadSample: true,
|
||||
},
|
||||
theme: {
|
||||
sidebar: {
|
||||
width: "250px",
|
||||
},
|
||||
},
|
||||
sitemap: {
|
||||
filename: "sitemap-docs.xml",
|
||||
},
|
||||
},
|
||||
],
|
||||
|
||||
Reference in New Issue
Block a user