bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
44 lines
1.6 KiB
Plaintext
44 lines
1.6 KiB
Plaintext
---
|
|
title: "Introduction"
|
|
description: "Primitives for building Medusa applications."
|
|
---
|
|
|
|
Welcome to Medusa UI, a React implementation of the Medusa design system.
|
|
It is a collection of components, hooks, utility functions, icons, and [Tailwind CSS](https://tailwindcss.com/) classes that can be used to build
|
|
a consistent user interface across the Medusa Admin and other Medusa applications.
|
|
|
|
<Card
|
|
title="Medusa UI"
|
|
text="Colors, type, icons and components"
|
|
href="https://www.figma.com/community/file/1278648465968635936/Medusa-UI"
|
|
startIcon={
|
|
<FigmaIcon />
|
|
}
|
|
/>
|
|
|
|
## Packages
|
|
|
|
---
|
|
|
|
Medusa UI is split into multiple packages. Each package is published to npm
|
|
and can be installed separately.
|
|
|
|
- `@medusajs/ui` - React components, hooks, and utility functions used
|
|
in Medusa UI.
|
|
- `@medusajs/ui-preset` - Tailwind CSS preset containing all the classes
|
|
used in Medusa UI.
|
|
- `@medusajs/icons` - Icons used in Medusa UI.
|
|
|
|
## About
|
|
|
|
---
|
|
|
|
At its core, Medusa UI is a styled and slightly opinionated implementation of [Radix Primitives](https://www.radix-ui.com/primitives).
|
|
Our team have also referenced the fantastic [shadcn/ui](https://ui.shadcn.com/) for inspiration in certain implementations.
|
|
|
|
Our team strongly believe in keeping the components simple and
|
|
composable, much like Medusa's foundation. This allows you to build whatever you need. Our team have tried to avoid overloading
|
|
the component API and, instead, leveraged the native HTML API, which gets implemented
|
|
and respected accordingly, and passed to the underlying elements.
|
|
|
|
<Feedback title={"Introduction"} /> |