* docs: added features and guides overview page * added image * added version 2 * added version 3 * added version 4 * docs: implemented new color scheme * docs: redesigned sidebar (#3193) * docs: redesigned navbar for restructure (#3199) * docs: redesigned footer (#3209) * docs: redesigned cards (#3230) * docs: redesigned admonitions (#3231) * docs: redesign announcement bar (#3236) * docs: redesigned large cards (#3239) * docs: redesigned code blocks (#3253) * docs: redesigned search modal and page (#3264) * docs: redesigned doc footer (#3268) * docs: added new sidebars + refactored css and assets (#3279) * docs: redesigned api reference sidebar * docs: refactored css * docs: added code tabs transition * docs: added new sidebars * removed unused assets * remove unusued assets * Fix deploy errors * fix incorrect link * docs: fixed code responsivity + missing icons (#3283) * docs: changed icons (#3296) * docs: design fixes to the sidebar (#3297) * redesign fixes * docs: small design fixes * docs: several design fixes after restructure (#3299) * docs: bordered icon fixes * docs: desgin fixes * fixes to code blocks and sidebar scroll * design adjustments * docs: restructured homepage (#3305) * docs: restructured homepage * design fixes * fixed core concepts icon * docs: added core concepts page (#3318) * docs: restructured homepage * design fixes * docs: added core concepts page * changed text of different components * docs: added architecture link * added missing prop for user guide * docs: added regions overview page (#3327) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page (#3331) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page * fix link * resolve link issues * docs: updated regions architecture image * docs: second-iteration fixes (#3347) * docs: redesigned document * design fixes * docs: added products overview page (#3354) * docs: added carts overview page (#3363) * docs: added orders overview (#3364) * docs: added orders overview * added links in overview * docs: added vercel redirects * docs: added soon badge for cards (#3389) * docs: resolved feedback changes + organized troubleshooting pages (#3409) * docs: resolved feedback changes * added extra line * docs: changed icons for restructure (#3421) * docs: added taxes overview page (#3422) * docs: added taxes overview page * docs: fix sidebar label * added link to taxes overview page * fixed link * docs: fixed sidebar scroll (#3429) * docs: added discounts overview (#3432) * docs: added discounts overview * fixed links * docs: added gift cards overview (#3433) * docs: added price lists overview page (#3440) * docs: added price lists overview page * fixed links * docs: added sales channels overview page (#3441) * docs: added sales overview page * fixed links * docs: added users overview (#3443) * docs: fixed sidebar border height (#3444) * docs: fixed sidebar border height * fixed svg markup * docs: added possible solutions to feedback component (#3449) * docs: added several overview pages + restructured files (#3463) * docs: added several overview pages * fixed links * docs: added feature flags + PAK overview pages (#3464) * docs: added feature flags + PAK overview pages * fixed links * fix link * fix link * fixed links colors * docs: added strategies overview page (#3468) * docs: automated upgrade guide (#3470) * docs: automated upgrade guide * fixed vercel redirect * docs: restructured files in docs codebase (#3475) * docs: restructured files * docs: fixed eslint exception * docs: finished restructure loose-ends (#3493) * fixed uses of backend * docs: finished loose ends * eslint fixes * fixed links * merged master * added update instructions for v1.7.12
212 lines
5.5 KiB
JavaScript
212 lines
5.5 KiB
JavaScript
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"
|
|
const algoliaApiKey = process.env.ALGOLIA_API_KEY || "temp"
|
|
|
|
const announcementBar = JSON.parse(fs.readFileSync('./announcement.json'))
|
|
|
|
/** @type {import('@docusaurus/types').DocusaurusConfig} */
|
|
const config = {
|
|
title: "Medusa",
|
|
tagline: "Explore and learn how to use Medusa",
|
|
url: "https://docs.medusajs.com",
|
|
baseUrl: "/",
|
|
onBrokenLinks: "throw",
|
|
onBrokenMarkdownLinks: "throw",
|
|
favicon: "img/favicon.ico",
|
|
organizationName: "medusajs",
|
|
projectName: "medusajs/www",
|
|
plugins: [
|
|
[
|
|
"docusaurus-plugin-segment",
|
|
{
|
|
apiKey: process.env.SEGMENT_API_KEY || "temp"
|
|
}
|
|
],
|
|
require.resolve("docusaurus-plugin-image-zoom"),
|
|
],
|
|
themeConfig: {
|
|
image: 'img/docs-banner.jpg',
|
|
colorMode: {
|
|
defaultMode: 'light',
|
|
disableSwitch: false,
|
|
respectPrefersColorScheme: true,
|
|
},
|
|
algolia: {
|
|
apiKey: algoliaApiKey,
|
|
indexName: "medusa-commerce",
|
|
placeholder: "Search docs...",
|
|
appId: algoliaAppId,
|
|
contextualSearch: false,
|
|
externalUrlRegex: "https://medusajs.com"
|
|
},
|
|
prism: {
|
|
defaultLanguage: "js",
|
|
plugins: ["line-numbers", "show-language"],
|
|
theme: require("./src/themes/medusaDocs"),
|
|
},
|
|
zoom: {
|
|
selector: '.markdown :not(.no-zoom-img) > img:not(.no-zoom-img)'
|
|
},
|
|
navbar: {
|
|
hideOnScroll: false,
|
|
logo: {
|
|
alt: "Medusa",
|
|
src: "img/logo.png",
|
|
srcDark: "img/logo-dark.png"
|
|
},
|
|
items: [
|
|
{
|
|
type: 'search',
|
|
position: 'left',
|
|
},
|
|
{
|
|
type: "docSidebar",
|
|
sidebarId: "homepage",
|
|
label: "Docs",
|
|
position: "right"
|
|
},
|
|
{
|
|
type: "docSidebar",
|
|
sidebarId: "userGuideSidebar",
|
|
label: "User Guide",
|
|
position: "right"
|
|
},
|
|
{
|
|
href: "/api/store",
|
|
label: "Store API",
|
|
prependBaseUrlToHref: true,
|
|
target: '_blank',
|
|
position: "right"
|
|
},
|
|
{
|
|
href: "/api/admin",
|
|
label: "Admin API",
|
|
prependBaseUrlToHref: true,
|
|
target: '_blank',
|
|
position: "right"
|
|
}
|
|
],
|
|
},
|
|
navbarActions: [
|
|
{
|
|
type: "link",
|
|
href: "https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml",
|
|
title: "Report an Issue",
|
|
icon: "report"
|
|
}
|
|
],
|
|
footer: {
|
|
copyright: `© ${new Date().getFullYear()} Medusa, Inc. All rights reserved.`,
|
|
},
|
|
socialLinks: [
|
|
{
|
|
type: 'discord',
|
|
href: 'https://discord.gg/medusajs'
|
|
},
|
|
{
|
|
type: 'twitter',
|
|
href: 'https://twitter.com/medusajs'
|
|
},
|
|
{
|
|
type: 'linkedin',
|
|
href: 'https://www.linkedin.com/company/medusajs'
|
|
},
|
|
{
|
|
type: 'github',
|
|
href: 'https://github.com/medusajs/medusa'
|
|
}
|
|
],
|
|
reportCodeLinkPrefix: 'https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml',
|
|
footerFeedback: {
|
|
event: 'survey'
|
|
},
|
|
docs: {
|
|
sidebar: {
|
|
autoCollapseCategories: true
|
|
}
|
|
}
|
|
},
|
|
presets: [
|
|
[
|
|
"@docusaurus/preset-classic",
|
|
{
|
|
docs: {
|
|
sidebarPath: require.resolve("./sidebars.js"),
|
|
editUrl: "https://github.com/medusajs/medusa/edit/master/docs/content",
|
|
path: docsPath,
|
|
routeBasePath: "/",
|
|
remarkPlugins: [
|
|
[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}],
|
|
],
|
|
showLastUpdateTime: true,
|
|
// breadcrumbs: false,
|
|
async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
|
|
const sidebarItems = await defaultSidebarItemsGenerator(args);
|
|
return reverseSidebar(sidebarItems, args.item);
|
|
},
|
|
},
|
|
theme: {
|
|
customCss: require.resolve("./src/css/custom.css")
|
|
},
|
|
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,
|
|
hideDownloadButton: true,
|
|
expandResponses: "200,204",
|
|
generatedPayloadSamplesMaxDepth: 4,
|
|
showObjectSchemaExamples: true,
|
|
requiredPropsFirst: true,
|
|
hideRequestPayloadSample: true
|
|
},
|
|
theme: {
|
|
sidebar: {
|
|
width: '250px'
|
|
}
|
|
}
|
|
}
|
|
},
|
|
],
|
|
],
|
|
}
|
|
|
|
if (Object.keys(announcementBar).length) {
|
|
config.themeConfig.announcementBar = announcementBar
|
|
}
|
|
|
|
module.exports = config
|