* 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
207 lines
5.7 KiB
Plaintext
207 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 a powerful and customizable REST API.',
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/admin/quickstart',
|
||
label: 'Medusa Admin Quickstart',
|
||
customProps: {
|
||
icon: Icons['computer-desktop-solid'],
|
||
description: 'The Medusa admin is an intuitive admin dashboard that can be used along with the Medusa backend and modules. Merchants can use it to perform data management and processes such as 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={4} 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 Storefront Quickstart',
|
||
customProps: {
|
||
icon: Icons['nextjs'],
|
||
description: 'Install the Next.js starter storefront and use it with the Medusa backend.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/starters/gatsby-medusa-starter',
|
||
label: 'Gatsby Storefront Quickstart',
|
||
customProps: {
|
||
icon: Icons['gatsby'],
|
||
description: 'Install the Gatsby starter storefront and use it with the Medusa backend.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/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: '/api/admin',
|
||
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/orders/admin/edit-order',
|
||
label: 'Edit an Order',
|
||
customProps: {
|
||
icon: Icons['pencil-square-solid'],
|
||
description: 'Gain more control over the order process by editing items in an order.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/sales-channels',
|
||
label: 'Sales Channels',
|
||
customProps: {
|
||
icon: Icons['channels-solid'],
|
||
description: 'Expand your market and set configurations for different channels.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/development/publishable-api-keys',
|
||
label: 'Publishable API Keys',
|
||
customProps: {
|
||
icon: Icons['key-solid'],
|
||
description: 'Scope API calls to specific resources using an API key'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<!-- 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. |