diff --git a/components/PostmanRunButton/readme.md b/components/PostmanRunButton/readme.md deleted file mode 100644 index 04c46b9aa..000000000 --- a/components/PostmanRunButton/readme.md +++ /dev/null @@ -1,26 +0,0 @@ -# Postman Run Button - -Add a Postman Run Button to your documentation, allowing users to fork a Postman collection. This is duped from [the version in our Marketplace](https://github.com/readmeio/marketplace/tree/main/components/PostmanRunButton) so our users can easily insert it via the editor. - -### Usage - -```mdx - -``` - -### How to Find Your Collection ID and URL - -1. Open your collection in Postman -2. Click "Share" button at the top right of your collection -3. Go to the "Via API" tab -4. You'll find your Collection ID in the URL or in the API response -5. The Collection URL contains parameters after the main URL (starting with "entityId=") - -### Props - -- `collectionId` (required): The ID of your Postman collection (e.g., "123456-abcd-efgh-ijkl") -- `collectionUrl` (required): The URL parameters for your collection, typically in this format: - `entityId=YOUR_COLLECTION_ID&entityType=collection&workspaceId=YOUR_WORKSPACE_ID` diff --git a/components/index.ts b/components/index.ts index 8f6240331..b450d5ec1 100644 --- a/components/index.ts +++ b/components/index.ts @@ -16,4 +16,4 @@ export { default as Tabs, Tab } from './Tabs'; export { default as TailwindRoot } from './TailwindRoot'; export { default as TailwindStyle } from './TailwindStyle'; export { default as Recipe } from './Recipe'; -export { default as PostmanRunButton } from './PostmanRunButton'; +export { default as Postman } from './integrations/PostmanRunButton'; \ No newline at end of file diff --git a/components/PostmanRunButton/index.tsx b/components/integrations/PostmanRunButton/index.tsx similarity index 100% rename from components/PostmanRunButton/index.tsx rename to components/integrations/PostmanRunButton/index.tsx diff --git a/components/integrations/PostmanRunButton/readme.md b/components/integrations/PostmanRunButton/readme.md new file mode 100644 index 000000000..2898df1bf --- /dev/null +++ b/components/integrations/PostmanRunButton/readme.md @@ -0,0 +1,28 @@ +# Postman Run Button + +Add a "Run in Postman" button to your documentation, allowing users to fork a Postman collection. This component is a dupe of [the version in our Marketplace](https://github.com/readmeio/marketplace/tree/main/components/PostmanRunButton) so our users can easily insert it via the editor. + +### Usage + +```mdx + +``` + +### How to Find Your Collection ID and URL + +1. Open your collection in Postman +2. Click "Share" button at the top right of your collection +3. Go to the "Via API" tab +4. You'll find your Collection ID in the URL or in the API response +5. The Collection URL contains parameters after the main URL (starting with `entityId=`) + +### Props + +- **`collectionId`**: (required) the ID of your Postman collection (e.g. `"123456-abcd-efgh-ijkl"`) +- **`collectionUrl`**: (required) the URL parameters for your collection, typically in this format: + ``` + entityId=YOUR_COLLECTION_ID&entityType=collection&workspaceId=YOUR_WORKSPACE_ID + ```