* 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
211 lines
5.7 KiB
Plaintext
211 lines
5.7 KiB
Plaintext
---
|
||
id: homepage
|
||
title: Medusa Documentation
|
||
description: "Medusa is an open source composable commerce platform. Learn about its features and how to use it."
|
||
slug: /
|
||
hide_table_of_contents: true
|
||
hide_footer: true
|
||
---
|
||
|
||
import DocCardList from '@theme/DocCardList';
|
||
import DocCard from '@theme/DocCard';
|
||
import Icons from '@theme/Icon';
|
||
|
||
# Medusa Documentation
|
||
|
||
Medusa is a set of commerce tools and modules that can be used to build unique commerce experiences.
|
||
|
||
Medusa provides the essential building blocks that developers can put together to create a powerful commerce store. Developers have full control over their tech stack and the logic behind the commerce features.
|
||
|
||
<DocCard item={{
|
||
type: 'link',
|
||
href: '/create-medusa-app',
|
||
label: 'Get Started',
|
||
customProps: {
|
||
icon: Icons['bolt-solid'],
|
||
html: 'Create a full-fledged Medusa project with one command.',
|
||
className: 'card-highlighted'
|
||
}
|
||
}} />
|
||
|
||
## Explore Medusa
|
||
|
||
<DocCardList colSize={4} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/overview',
|
||
label: 'Commerce Modules',
|
||
customProps: {
|
||
icon: Icons['puzzle-solid'],
|
||
description: 'Learn about the available ecommerce features and how to use and customize them.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/development/overview',
|
||
label: 'Medusa Development',
|
||
customProps: {
|
||
icon: Icons['server-stack-solid'],
|
||
description: 'Learn how to develop customized digital commerce applications with Medusa.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/user-guide',
|
||
label: 'User Guide',
|
||
customProps: {
|
||
icon: Icons['users-solid'],
|
||
description: 'No-code guides to help users manage their ecommerce stores using the Medusa admin.'
|
||
}
|
||
}
|
||
]} />
|
||
|
||
## Medusa Toolkit
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/development/backend/install',
|
||
label: 'Medusa Backend',
|
||
customProps: {
|
||
icon: Icons['circle-stack-solid'],
|
||
html: 'A Medusa Backend is any Node.js project with @medusajs/medusa installed. The core Medusa package orchestrates Medusa\'s Commerce Modules to expose powerful and customizable REST APIs.',
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/admin/quickstart',
|
||
label: 'Admin Dashboard',
|
||
customProps: {
|
||
icon: Icons['computer-desktop-solid'],
|
||
description: 'An admin dashboard used along with the Medusa backend and commerce modules. Merchants can use it to manage orders, products, customers, and much more.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<DocCardList colSize={4} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/js-client/overview',
|
||
label: 'JavaScript Client',
|
||
customProps: {
|
||
icon: Icons['javascript'],
|
||
description: 'Interact with a Medusa backend from a storefront or an admin built with any JavaScript framework.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/medusa-react/overview',
|
||
label: 'Medusa React',
|
||
customProps: {
|
||
icon: Icons['react'],
|
||
description: 'Interact with a Medusa backend from a React storefront or admin with utilities, hooks, and contexts.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/plugins/overview',
|
||
label: 'Plugins',
|
||
customProps: {
|
||
icon: Icons['squares-plus-solid'],
|
||
description: 'Supercharge your Medusa backend with plugins for Storage, Notifications, Analytics, and more.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/cli/reference',
|
||
label: 'Medusa CLI',
|
||
customProps: {
|
||
icon: Icons['command-line-solid'],
|
||
description: 'Use the Medusa CLI tool to execute commands on your Medusa backend.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/starters/nextjs-medusa-starter',
|
||
label: 'Next.js Starter Template',
|
||
customProps: {
|
||
icon: Icons['nextjs'],
|
||
description: 'Install the Next.js starter template and use it as the storefront for the Medusa backend.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: 'https://docs.medusajs.com/api/admin',
|
||
label: 'Admin API Reference',
|
||
customProps: {
|
||
icon: Icons['circle-stack-solid'],
|
||
description: 'Check out available REST APIs with example code snippets.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: 'https://docs.medusajs.com/api/store',
|
||
label: 'Store API Reference',
|
||
customProps: {
|
||
icon: Icons['computer-desktop-solid'],
|
||
description: 'Check out available REST APIs with example code snippets.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
## What's New
|
||
|
||
Learn about all the new features and enhancements in Medusa.
|
||
|
||
<DocCardList colSize={4} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/products/serverless-module',
|
||
label: 'Product Module',
|
||
customProps: {
|
||
icon: Icons['tag-solid'],
|
||
description: 'Learn about the new product module and how to use it in a serverless setup.',
|
||
badge: {
|
||
variant: 'orange',
|
||
children: 'Beta'
|
||
}
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/admin/widgets',
|
||
label: 'Admin Widgets',
|
||
customProps: {
|
||
icon: Icons['component-solid'],
|
||
description: 'Learn how you can customize the admin dashboard with admin widgets.',
|
||
badge: {
|
||
variant: 'orange',
|
||
children: 'Beta'
|
||
}
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/admin/routes',
|
||
label: 'Admin UI Routes',
|
||
customProps: {
|
||
icon: Icons['computer-desktop-solid'],
|
||
description: 'Learn how you can customize the admin dashboard with admin UI routes.',
|
||
badge: {
|
||
variant: 'orange',
|
||
children: 'Beta'
|
||
}
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<!-- vale docs.HeadingPunctuation = NO -->
|
||
|
||
## Need Help?
|
||
|
||
<!-- vale docs.HeadingPunctuation = YES -->
|
||
|
||
If you’re still not sure that Medusa is the right solution for you, you can get in-touch with the core Medusa team over at [Discord](https://discord.gg/medusajs) and get help from the community.
|