docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
This commit is contained in:
Shahed Nasser
GitHub
206
www/apps/docs/content/homepage.mdx
Normal file
206
www/apps/docs/content/homepage.mdx
Normal file
@@ -0,0 +1,206 @@
|
||||
---
|
||||
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: 'https://docs.medusajs.com/ui',
|
||||
label: 'Medusa UI',
|
||||
customProps: {
|
||||
icon: Icons['tag-solid'],
|
||||
description: 'Check out the Medusa UI package, a React implementation of the Medusa design system.',
|
||||
}
|
||||
},
|
||||
{
|
||||
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.
|
||||
Reference in New Issue
Block a user