asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: refactor to use TypeScript, ESLint, and Tailwind CSS (#4136)

Browse Source 
* docs(refactoring): configured eslint and typescript (#3511)

* docs: configured eslint and typescript

* fixed yarn.lock

* docs(refactoring): migrate components directory to typescript (#3517)

* docs: migrate components directory to typescript

* removed vscode settings

* fix following merge

* docs: refactored QueryNote component (#3576)

* docs: refactored first batch of theme components (#3579)

* docs: refactored second batch of theme components (#3580)

* added missing badge styles

* fix after merge

* docs(refactoring): migrated remaining component to TypeScript (#3770)

* docs(refactoring): configured eslint and typescript (#3511)

* docs: configured eslint and typescript

* fixed yarn.lock

* docs(refactoring): migrate components directory to typescript (#3517)

* docs: migrate components directory to typescript

* removed vscode settings

* fix following merge

* docs: refactored QueryNote component (#3576)

* docs: refactored first batch of theme components (#3579)

* docs: refactored second batch of theme components (#3580)

* added missing badge styles

* docs: refactoring second batch of theme components

* fix after merge

* refactored icons and other components

* docs: refactored all components

* docs(refactoring): set up and configured Tailwind Css (#3841)

* docs: added tailwind config

* docs: added more tailwind configurations

* add includes option

* added more tailwind configurations

* fix to configurations

* docs(refactoring): use tailwind css (#4134)

* docs: added tailwind config

* docs: added more tailwind configurations

* add includes option

* added more tailwind configurations

* fix to configurations

* docs(refactoring): refactored all styles to use tailwind css (#4132)

* refactored Badge component to use tailwind css

* refactored Bordered component to use tailwind css

* updated to latest docusaurus

* refactored BorderedIcon component to use tailwind css

* refactored Feedback component to use tailwind css

* refactored icons and footersociallinks to tailwind css

* start refactoring of large card

* refactored large card styling

* refactored until admonitions

* refactored until codeblock

* refactored until Tabs

* refactored Tabs (without testing

* finished refactoring styles to tailwind css

* upgraded to version 2.4.1

* general fixes

* adjusted eslint configurations

* fixed ignore files

* fixes to large card

* fix search styling

* fix npx command

* updated tabs to use isCodeTabs prop

* fixed os tabs

* removed os-tabs class in favor of general styling

* improvements to buttons

* fix for searchbar

* fixed redocly download button

* chore: added eslint code action (#4135)

* small change in commerce modules page
This commit is contained in:
Shahed Nasser
2023-05-19 14:56:48 +03:00
committed by GitHub
parent 29a88bbf98
commit 94907730d2
292 changed files with 11721 additions and 42102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/content/development/backend/development.module.css
View File

@@ -1,11 +0,0 @@
.osTabs {
background-color: var(--ifm-note-background);
padding: 10px;
border: 1px solid var(--ifm-note-border-color);
border-radius: var(--ifm-global-radius);
color: var(--ifm-alert-foreground-color);
}
.osTabs li:not([aria-selected=true]) {
color: var(--ifm-color-content);
}

9
docs/content/development/backend/prepare-environment.mdx
View File

@@ -2,7 +2,6 @@
description: 'Learn how to prepare your development environment while using Medusa. This guide includes how to install Node.js, Git, Medusa CLI tool, and PostgreSQL.'
---
import styles from './development.module.css';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -28,7 +27,7 @@ node -v
:::
<Tabs groupId="operating-systems" wrapperClassName={styles.osTabs}>
<Tabs groupId="operating-systems">
<TabItem value="windows" label="Windows" default>
You can install the executable directly from [the Node.js website](https://nodejs.org/en/#home-downloadhead).
@@ -53,7 +52,7 @@ For other Linux distributions, you can check out [Node.js’s guide](https://nod
You can use the following commands to install Node.js on macOS:
<Tabs groupId="homebrew" wrapperClassName='code-tabs'>
<Tabs groupId="homebrew" isCodeTabs={true}>
<TabItem value="homebrew" label="Homebrew">
```bash
@@ -89,7 +88,7 @@ Make sure that you have Xcode command line tools installed; if not, run the fol
Medusa uses Git behind the scenes when you create a new project so you'll have to install it on your computer to get started.
<Tabs groupId="operating-systems" wrapperClassName={styles.osTabs}>
<Tabs groupId="operating-systems">
<TabItem value="windows" label="Windows" default>
To install Git on Windows, you need to [download the installable package](https://git-scm.com/download/win).
@@ -165,7 +164,7 @@ After installing PostgreSQL, check out the [Configure your Backend documentation
:::
<Tabs groupId="operating-systems" wrapperClassName={styles.osTabs}>
<Tabs groupId="operating-systems">
<TabItem value="windows" label="Windows">
You can [download the PostgreSQL Windows installer](https://www.postgresql.org/download/windows/) from their website.

6
docs/content/development/batch-jobs/create.mdx
View File

@@ -302,7 +302,7 @@ The first step is to create a batch job using the [Create Batch Job endpoint](/a
For example, this creates a batch job of the type `publish-products`:
<Tabs groupId="request-types" wrapperClassName="code-tabs">
<Tabs groupId="request-types" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```jsx
@@ -363,7 +363,7 @@ Make sure to replace `<BACKEND_URL>` with the backend URL where applicable.
You can retrieve the batch job afterward to get its status and view details about the process in the `result` property:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```jsx
@@ -418,7 +418,7 @@ Based on the batch job strategy implemented in this documentation, the `result`
To process the batch job, send a request to [confirm the batch job](/api/admin/#tag/Batch-Job/operation/PostBatchJobsBatchJobConfirmProcessing):
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```jsx

16
docs/content/development/publishable-api-keys/admin/manage-publishable-api-keys.mdx
View File

@@ -63,7 +63,7 @@ You can learn more about [authenticating as an admin user in the API reference](
You can retrieve a list of publishable API keys by sending a request to the [List Publishable API Keys](/api/admin/#tag/PublishableApiKey/operation/GetPublishableApiKeys) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts
@@ -154,7 +154,7 @@ You can learn more about pagination in the [API reference](/api/admin/#section/P
You can create a publishable API key by sending a request to the [Create Publishable API Key](/api/admin/#tag/PublishableApiKey/operation/PostPublishableApiKeys) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts
@@ -233,7 +233,7 @@ It returns the created publishable API key in the response.
You can update a publishable API key’s details by sending a request to the [Update Publishable API Key](/api/admin/#tag/PublishableApiKey/operation/PostPublishableApiKysPublishableApiKey) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts
@@ -318,7 +318,7 @@ Revoking a publishable API key does not remove it, but does not allow using it i
You can revoke a publishable API key by sending a request to the [Revoke Publishable API Key](/api/admin/#tag/PublishableApiKey/operation/PostPublishableApiKeysPublishableApiKeyRevoke) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts
@@ -388,7 +388,7 @@ This request requires the ID of the publishable API key as a path parameter. It
You can delete a publishable API key by sending a request to the [Delete Publishable API Key](/api/admin/#tag/PublishableApiKey/operation/DeletePublishableApiKeysPublishableApiKey) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts
@@ -465,7 +465,7 @@ This section covers how to manage sales channels in a publishable API key. This
You can retrieve the list of sales channels associated with a publishable API key by sending a request to the [List Sales Channels](/api/admin/#tag/PublishableApiKey/operation/GetPublishableApiKeySalesChannels) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts
@@ -548,7 +548,7 @@ It returns an array of sales channels associated with the publishable API key in
You can add a sales channel to a publishable API key by sending a request to the [Add Sales Channels](/api/admin/#tag/PublishableApiKey/operation/PostPublishableApiKeySalesChannelsChannelsBatch) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts
@@ -658,7 +658,7 @@ This request returns the updated publishable API key in the response.
You can delete a sales channel from a publishable API key by sending a request to the [Delete Sales Channels](/api/admin/#tag/PublishableApiKey/operation/DeletePublishableApiKeySalesChannelsChannelsBatch) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<Tabs groupId="request-type" isCodeTabs={true}>
<TabItem value="client" label="Medusa JS Client" default>
```ts