From e15c4112d834c7a9129760e0e07448a3473c9136 Mon Sep 17 00:00:00 2001 From: "shunquan.wang" Date: Sat, 14 Sep 2024 15:02:50 +0800 Subject: [PATCH 1/2] docs: add plugins docs --- website/docs/adapters/google-adapter.md | 1 - website/docs/{changelog.md => changelog.mdx} | 2 - website/docs/{faq.md => faq.mdx} | 0 website/docs/intro/installation.md | 8 +- website/docs/plugins/facebook-adapter.mdx | 42 ++ .../docs/plugins/facebook-events/contact.mdx | 14 + .../facebook-events/customize_product.mdx | 14 + .../docs/plugins/facebook-events/donate.mdx | 14 + .../plugins/facebook-events/find_location.mdx | 14 + .../docs/plugins/facebook-events/schedule.mdx | 14 + .../plugins/facebook-events/start_trial.mdx | 30 + .../facebook-events/submit_application.mdx | 14 + .../plugins/facebook-events/subscribe.mdx | 28 + website/docs/plugins/google-adapter.mdx | 37 ++ .../google-events/add_shipping_info.mdx | 50 ++ website/docs/plugins/google-events/login.mdx | 18 + website/docs/plugins/google-events/refund.mdx | 64 ++ .../google-events/remove_from_cart.mdx | 36 ++ .../plugins/google-events/select_content.mdx | 24 + .../plugins/google-events/select_item.mdx | 30 + .../google-events/select_promotion.mdx | 42 ++ website/docs/plugins/google-events/share.mdx | 30 + .../plugins/google-events/tutorial_begin.mdx | 14 + .../google-events/tutorial_complete.mdx | 14 + website/docs/plugins/klaviyo-adapter.mdx | 45 ++ .../plugins/klaviyo-events/clicked_banner.mdx | 30 + .../klaviyo-events/klaviyo_account.mdx | 21 + .../klaviyo-events/klaviyo_cookie_domain.mdx | 21 + .../klaviyo-events/klaviyo_identify.mdx | 19 + .../klaviyo-events/klaviyo_open_form.mdx | 33 ++ .../klaviyo_track_viewed_item.mdx | 19 + .../klaviyo-events/referred_friend.mdx | 24 + .../plugins/klaviyo-events/shared_article.mdx | 42 ++ .../klaviyo-events/viewed_category.mdx | 36 ++ .../standard-events/add_payment_info.mdx | 50 ++ .../plugins/standard-events/add_to_cart.mdx | 96 +++ .../standard-events/add_to_wishlist.mdx | 36 ++ .../standard-events/begin_checkout.mdx | 60 ++ .../plugins/standard-events/page_view.mdx | 54 ++ .../docs/plugins/standard-events/purchase.mdx | 64 ++ .../docs/plugins/standard-events/search.mdx | 24 + .../docs/plugins/standard-events/sign_up.mdx | 18 + .../plugins/standard-events/view_cart.mdx | 36 ++ .../plugins/standard-events/view_item.mdx | 34 ++ .../standard-events/view_item_list.mdx | 46 ++ .../standard-events/view_promotion.mdx | 63 ++ .../plugins/types/standard-goods-item.mdx | 154 +++++ website/docusaurus.config.ts | 12 + website/package.json | 9 +- website/sidebars.ts | 84 ++- website/src/components/FlexLayout/index.tsx | 21 + website/src/components/NpmLink/index.tsx | 50 ++ website/src/components/Platform/index.tsx | 36 ++ website/src/components/Property/index.tsx | 9 + website/src/components/Required/index.tsx | 21 + website/src/theme/MDXComponents.js | 15 + yarn.lock | 555 ++++++++++++++---- 57 files changed, 2238 insertions(+), 153 deletions(-) delete mode 100644 website/docs/adapters/google-adapter.md rename website/docs/{changelog.md => changelog.mdx} (85%) rename website/docs/{faq.md => faq.mdx} (100%) create mode 100644 website/docs/plugins/facebook-adapter.mdx create mode 100644 website/docs/plugins/facebook-events/contact.mdx create mode 100644 website/docs/plugins/facebook-events/customize_product.mdx create mode 100644 website/docs/plugins/facebook-events/donate.mdx create mode 100644 website/docs/plugins/facebook-events/find_location.mdx create mode 100644 website/docs/plugins/facebook-events/schedule.mdx create mode 100644 website/docs/plugins/facebook-events/start_trial.mdx create mode 100644 website/docs/plugins/facebook-events/submit_application.mdx create mode 100644 website/docs/plugins/facebook-events/subscribe.mdx create mode 100644 website/docs/plugins/google-adapter.mdx create mode 100644 website/docs/plugins/google-events/add_shipping_info.mdx create mode 100644 website/docs/plugins/google-events/login.mdx create mode 100644 website/docs/plugins/google-events/refund.mdx create mode 100644 website/docs/plugins/google-events/remove_from_cart.mdx create mode 100644 website/docs/plugins/google-events/select_content.mdx create mode 100644 website/docs/plugins/google-events/select_item.mdx create mode 100644 website/docs/plugins/google-events/select_promotion.mdx create mode 100644 website/docs/plugins/google-events/share.mdx create mode 100644 website/docs/plugins/google-events/tutorial_begin.mdx create mode 100644 website/docs/plugins/google-events/tutorial_complete.mdx create mode 100644 website/docs/plugins/klaviyo-adapter.mdx create mode 100644 website/docs/plugins/klaviyo-events/clicked_banner.mdx create mode 100644 website/docs/plugins/klaviyo-events/klaviyo_account.mdx create mode 100644 website/docs/plugins/klaviyo-events/klaviyo_cookie_domain.mdx create mode 100644 website/docs/plugins/klaviyo-events/klaviyo_identify.mdx create mode 100644 website/docs/plugins/klaviyo-events/klaviyo_open_form.mdx create mode 100644 website/docs/plugins/klaviyo-events/klaviyo_track_viewed_item.mdx create mode 100644 website/docs/plugins/klaviyo-events/referred_friend.mdx create mode 100644 website/docs/plugins/klaviyo-events/shared_article.mdx create mode 100644 website/docs/plugins/klaviyo-events/viewed_category.mdx create mode 100644 website/docs/plugins/standard-events/add_payment_info.mdx create mode 100644 website/docs/plugins/standard-events/add_to_cart.mdx create mode 100644 website/docs/plugins/standard-events/add_to_wishlist.mdx create mode 100644 website/docs/plugins/standard-events/begin_checkout.mdx create mode 100644 website/docs/plugins/standard-events/page_view.mdx create mode 100644 website/docs/plugins/standard-events/purchase.mdx create mode 100644 website/docs/plugins/standard-events/search.mdx create mode 100644 website/docs/plugins/standard-events/sign_up.mdx create mode 100644 website/docs/plugins/standard-events/view_cart.mdx create mode 100644 website/docs/plugins/standard-events/view_item.mdx create mode 100644 website/docs/plugins/standard-events/view_item_list.mdx create mode 100644 website/docs/plugins/standard-events/view_promotion.mdx create mode 100644 website/docs/plugins/types/standard-goods-item.mdx create mode 100644 website/src/components/FlexLayout/index.tsx create mode 100644 website/src/components/NpmLink/index.tsx create mode 100644 website/src/components/Platform/index.tsx create mode 100644 website/src/components/Property/index.tsx create mode 100644 website/src/components/Required/index.tsx create mode 100644 website/src/theme/MDXComponents.js diff --git a/website/docs/adapters/google-adapter.md b/website/docs/adapters/google-adapter.md deleted file mode 100644 index c538aec..0000000 --- a/website/docs/adapters/google-adapter.md +++ /dev/null @@ -1 +0,0 @@ -# GoogleAdapter diff --git a/website/docs/changelog.md b/website/docs/changelog.mdx similarity index 85% rename from website/docs/changelog.md rename to website/docs/changelog.mdx index 735ea60..0c2ddd4 100644 --- a/website/docs/changelog.md +++ b/website/docs/changelog.mdx @@ -3,5 +3,3 @@ sidebar_position: 1 --- # ChangeLog - -12312 diff --git a/website/docs/faq.md b/website/docs/faq.mdx similarity index 100% rename from website/docs/faq.md rename to website/docs/faq.mdx diff --git a/website/docs/intro/installation.md b/website/docs/intro/installation.md index d22cf11..9347413 100644 --- a/website/docs/intro/installation.md +++ b/website/docs/intro/installation.md @@ -6,16 +6,10 @@ ## Install -```bash +```bash npm2yarn npm install @hyperse/track --save ``` -or you can use **yarn** - -```bash -yarn add @hyperse/track -``` - We have completed installing the package. ## Congratulations ! diff --git a/website/docs/plugins/facebook-adapter.mdx b/website/docs/plugins/facebook-adapter.mdx new file mode 100644 index 0000000..399bbee --- /dev/null +++ b/website/docs/plugins/facebook-adapter.mdx @@ -0,0 +1,42 @@ +--- +title: FacebookAdapter +description: FacebookAdapter +hide_table_of_contents: true +--- + +The FacebookAdapter streamlines the integration of Facebook Pixel event tracking within your @hyperse/track system, enabling you to leverage the full power of the Meta Pixel for comprehensive data collection and analysis. + +**Key Features:** + +- **Streamlined Pixel Integration:** Seamlessly integrate your Facebook Pixel with your @hyperse/track setup for a unified and efficient tracking experience. +- **TypeScript Typing:** Benefit from robust type safety and code completion through TypeScript definitions, ensuring accurate event data and reducing errors. +- **Comprehensive Event Tracking:** Track a wide range of events, including those essential for optimizing conversions, such as: + - **View Content:** Track when users view specific products or content. + - **Add to Cart:** Capture when users add items to their shopping carts. + - **Initiate Checkout:** Monitor when users begin the checkout process. + - **Complete Purchase:** Track successful purchases and their associated revenue. +- **Enhanced Conversion Optimization:** Leverage the rich event data collected through the Meta Pixel to create custom audiences, personalize ads, and optimize your Facebook Ads campaigns for better results. + +**Benefits:** + +- **Improved Audience Targeting:** Precisely target your Facebook Ads campaigns based on detailed user behavior data collected through the Meta Pixel, reaching your ideal audience effectively. +- **Enhanced Conversion Tracking:** Accurately track conversions and measure the effectiveness of your Facebook Ads, ensuring your advertising budget is allocated efficiently. +- **Data-Driven Insights:** Gain a deeper understanding of your audience and their engagement with your website, allowing you to make informed decisions about your marketing strategy. +- **Streamlined Workflow:** Simplify your tracking setup and management with a unified solution for both Facebook Pixel and your @hyperse/track system, reducing complexity and streamlining your workflow. +- **Improved Code Quality:** TypeScript types ensure accurate event data and prevent potential errors, leading to more reliable tracking and a cleaner codebase. + +**With the FacebookAdapter, you can:** + +- **Optimize Your Facebook Ads:** Use event data to create custom audiences, target relevant users, and personalize ads for higher conversion rates. +- **Analyze Customer Behavior:** Gain insights into customer journey stages, enabling you to identify areas for improvement and optimize user experience. +- **Increase Conversions:** Drive higher conversion rates by identifying and addressing potential pain points in the customer journey, ultimately leading to more sales. + +**For a comprehensive guide on Facebook Pixel implementation, refer to the official documentation:** [https://developers.facebook.com/docs/meta-pixel/implementation/conversion-tracking](https://developers.facebook.com/docs/meta-pixel/implementation/conversion-tracking) + +**Embrace the power of the Facebook Pixel and @hyperse/track with the FacebookAdapter. Unlock valuable data, optimize your advertising efforts, and drive better business outcomes.** + +## Install + +```bash npm2yarn +npm install @hyperse-hub/track-plugin-facebook --save +``` diff --git a/website/docs/plugins/facebook-events/contact.mdx b/website/docs/plugins/facebook-events/contact.mdx new file mode 100644 index 0000000..2b3756e --- /dev/null +++ b/website/docs/plugins/facebook-events/contact.mdx @@ -0,0 +1,14 @@ +--- +title: contact +description: contact +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When a person initiates contact with your business via telephone, SMS, email, chat, etc. + +## Parameters + +This parameter is optional and can be defined by users diff --git a/website/docs/plugins/facebook-events/customize_product.mdx b/website/docs/plugins/facebook-events/customize_product.mdx new file mode 100644 index 0000000..ce93d87 --- /dev/null +++ b/website/docs/plugins/facebook-events/customize_product.mdx @@ -0,0 +1,14 @@ +--- +title: customize_product +description: customize_product +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When a person customizes a product. + +## Parameters + +This parameter is optional and can be defined by users diff --git a/website/docs/plugins/facebook-events/donate.mdx b/website/docs/plugins/facebook-events/donate.mdx new file mode 100644 index 0000000..26ea506 --- /dev/null +++ b/website/docs/plugins/facebook-events/donate.mdx @@ -0,0 +1,14 @@ +--- +title: donate +description: donate +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When a person donates funds to your organization or cause. + +## Parameters + +This parameter is optional and can be defined by users diff --git a/website/docs/plugins/facebook-events/find_location.mdx b/website/docs/plugins/facebook-events/find_location.mdx new file mode 100644 index 0000000..133dd33 --- /dev/null +++ b/website/docs/plugins/facebook-events/find_location.mdx @@ -0,0 +1,14 @@ +--- +title: find_location +description: find_location +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When a person searches for a location of your store via a website or app, with an intention to visit the physical location. + +## Parameters + +This parameter is optional and can be defined by users diff --git a/website/docs/plugins/facebook-events/schedule.mdx b/website/docs/plugins/facebook-events/schedule.mdx new file mode 100644 index 0000000..23a15f4 --- /dev/null +++ b/website/docs/plugins/facebook-events/schedule.mdx @@ -0,0 +1,14 @@ +--- +title: schedule +description: schedule +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When a person books an appointment to visit one of your locations. + +## Parameters + +This parameter is optional and can be defined by users diff --git a/website/docs/plugins/facebook-events/start_trial.mdx b/website/docs/plugins/facebook-events/start_trial.mdx new file mode 100644 index 0000000..37bda8b --- /dev/null +++ b/website/docs/plugins/facebook-events/start_trial.mdx @@ -0,0 +1,30 @@ +--- +title: start_trial +description: start_trial +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When a person starts a free trial of a product or service you offer. + +## Parameters + +### currency + + `string` + +The currency of the specified `value`. + +### predicted_ltv + + `number` + +The predicted lifetime value of a subscriber, as defined by the advertiser, expressed as a precise value. + +### value + + `number` + +The value for the user performing this event to the business. diff --git a/website/docs/plugins/facebook-events/submit_application.mdx b/website/docs/plugins/facebook-events/submit_application.mdx new file mode 100644 index 0000000..fb54b40 --- /dev/null +++ b/website/docs/plugins/facebook-events/submit_application.mdx @@ -0,0 +1,14 @@ +--- +title: submit_application +description: submit_application +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When a person applies for a product, service, or program you offer. + +## Parameters + +This parameter is optional and can be defined by users diff --git a/website/docs/plugins/facebook-events/subscribe.mdx b/website/docs/plugins/facebook-events/subscribe.mdx new file mode 100644 index 0000000..23b766d --- /dev/null +++ b/website/docs/plugins/facebook-events/subscribe.mdx @@ -0,0 +1,28 @@ +--- +title: subscribe +description: subscribe +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When a person applies to a start a paid subscription for a product or service you offer. + +### currency + + `string` + +The currency of the specified `value`. + +### predicted_ltv + + `number` + +The predicted lifetime value of a subscriber, as defined by the advertiser, expressed as a precise value. + +### value + + `number` + +The value for the user performing this event to the business. diff --git a/website/docs/plugins/google-adapter.mdx b/website/docs/plugins/google-adapter.mdx new file mode 100644 index 0000000..f691fcf --- /dev/null +++ b/website/docs/plugins/google-adapter.mdx @@ -0,0 +1,37 @@ +--- +title: GoogleAdapter +description: GoogleAdapter +hide_table_of_contents: true +--- + +The GoogleAdapter empowers you to seamlessly integrate your Google Analytics and Google Ads event tracking within your @hyperse/track setup. + +**Key Features:** + +- **Unified Tracking:** Capture and send events to both Google Analytics and Google Ads through a single, consistent interface. +- **TypeScript Typing:** Enjoy robust type safety and code completion through TypeScript definitions, ensuring accurate event data and reducing errors. +- **Effortless Integration:** Integrate the GoogleAdapter effortlessly into your @hyperse/track system, enabling fast and efficient tracking setup. +- **Comprehensive Event Data:** Track a wide range of events, including page views, form submissions, user interactions, and more, providing you with valuable insights. + +**Benefits:** + +- **Enhanced Insights:** Gain a deeper understanding of your users' behavior across both Google Analytics and Google Ads. +- **Improved Targeting:** Optimize your Google Ads campaigns by leveraging accurate user behavior data from your website. +- **Streamlined Workflow:** Simplify your tracking setup and management with a unified solution for both platforms. +- **Improved Code Quality:** TypeScript types ensure accurate event data and prevent potential errors. + +**With the GoogleAdapter, you can:** + +- Track critical events on your website. +- Analyze user behavior and engagement. +- Optimize your Google Ads campaigns for better results. + +**For more information on Google Analytics and Google Ads, refer to the official documentation:** [https://developers.google.com/analytics/devguides/collection/](https://developers.google.com/analytics/devguides/collection/) + +**Embrace the power of data-driven decision-making with the GoogleAdapter. Enhance your tracking capabilities, streamline your workflow, and unlock valuable insights for your business.** + +## Install + +```bash npm2yarn +npm install @hyperse-hub/track-plugin-google --save +``` diff --git a/website/docs/plugins/google-events/add_shipping_info.mdx b/website/docs/plugins/google-events/add_shipping_info.mdx new file mode 100644 index 0000000..e8af217 --- /dev/null +++ b/website/docs/plugins/google-events/add_shipping_info.mdx @@ -0,0 +1,50 @@ +--- +title: add_shipping_info +description: add_shipping_info +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies a user has submitted their shipping information in an ecommerce checkout process. + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### coupon + + `string` + +The coupon name/code associated with the event. + +Event-level and item-level coupon parameters are independent. + +### shipping_tier + + `string` + +The shipping tier (e.g. Ground, Air, Next-day) selected for delivery of the purchased item. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/google-events/login.mdx b/website/docs/plugins/google-events/login.mdx new file mode 100644 index 0000000..47f1774 --- /dev/null +++ b/website/docs/plugins/google-events/login.mdx @@ -0,0 +1,18 @@ +--- +title: login +description: login +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +Send this event to signify that a user has logged in to your website or app. + +## Parameters + +### method + + `string` + +The method used to login. diff --git a/website/docs/plugins/google-events/refund.mdx b/website/docs/plugins/google-events/refund.mdx new file mode 100644 index 0000000..4a29fd4 --- /dev/null +++ b/website/docs/plugins/google-events/refund.mdx @@ -0,0 +1,64 @@ +--- +title: refund +description: refund +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies when one or more items is refunded to a user. + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### transaction_id + + `string` + +The unique identifier of a transaction. + +The `transaction_id` parameter helps you avoid getting duplicate events for a purchase. + +### coupon + + `string` + +The coupon name/code associated with the event. + +Event-level and item-level coupon parameters are independent. + +### shipping + + `number` + +Shipping cost associated with a transaction. + +### tax + + `number` + +Tax cost associated with a transaction. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/google-events/remove_from_cart.mdx b/website/docs/plugins/google-events/remove_from_cart.mdx new file mode 100644 index 0000000..0375a48 --- /dev/null +++ b/website/docs/plugins/google-events/remove_from_cart.mdx @@ -0,0 +1,36 @@ +--- +title: remove_from_cart +description: remove_from_cart +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies that an item was removed from a cart. + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/google-events/select_content.mdx b/website/docs/plugins/google-events/select_content.mdx new file mode 100644 index 0000000..6d48e6f --- /dev/null +++ b/website/docs/plugins/google-events/select_content.mdx @@ -0,0 +1,24 @@ +--- +title: select_content +description: select_content +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies that a user has selected some content of a certain type. This event can help you identify popular content and categories of content on your website or app. + +## Parameters + +### content_type + + `string` + +The type of selected content. + +### content_id + + `string` + +An identifier for the content that was selected. diff --git a/website/docs/plugins/google-events/select_item.mdx b/website/docs/plugins/google-events/select_item.mdx new file mode 100644 index 0000000..7c50448 --- /dev/null +++ b/website/docs/plugins/google-events/select_item.mdx @@ -0,0 +1,30 @@ +--- +title: select_item +description: select_item +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies an item was selected from a list. + +## Parameters + +### item_list_id + + `string` + +The ID of the list in which the item was presented to the user. + +### item_list_name + + `string` + +The name of the list in which the item was presented to the user. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/google-events/select_promotion.mdx b/website/docs/plugins/google-events/select_promotion.mdx new file mode 100644 index 0000000..4d4684f --- /dev/null +++ b/website/docs/plugins/google-events/select_promotion.mdx @@ -0,0 +1,42 @@ +--- +title: select_promotion +description: select_promotion +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies a promotion was selected from a list. + +## Parameters + +### creative_name + + `string` + +The name of the promotional creative. + +### creative_slot + + `string` + +The name of the promotional creative slot associated with the event. + +### promotion_id + + `string` + +The ID of the promotion associated with the event. + +### promotion_name + + `string` + +The name of the promotion associated with the event. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/google-events/share.mdx b/website/docs/plugins/google-events/share.mdx new file mode 100644 index 0000000..a98b408 --- /dev/null +++ b/website/docs/plugins/google-events/share.mdx @@ -0,0 +1,30 @@ +--- +title: share +description: share +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +Use this event when a user has shared content. + +## Parameters + +### method + + `string` + +The method in which the content is shared. + +### content_type + + `string` + +The type of shared content. + +### item_id + + `string` + +The ID of the shared content. diff --git a/website/docs/plugins/google-events/tutorial_begin.mdx b/website/docs/plugins/google-events/tutorial_begin.mdx new file mode 100644 index 0000000..5628aa7 --- /dev/null +++ b/website/docs/plugins/google-events/tutorial_begin.mdx @@ -0,0 +1,14 @@ +--- +title: tutorial_begin +description: tutorial_begin +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies the start of the on-boarding process. Use this in a funnel with tutorial_complete to understand how many users complete the tutorial. + +## Parameters + +There are no parameters for this event. diff --git a/website/docs/plugins/google-events/tutorial_complete.mdx b/website/docs/plugins/google-events/tutorial_complete.mdx new file mode 100644 index 0000000..70035c3 --- /dev/null +++ b/website/docs/plugins/google-events/tutorial_complete.mdx @@ -0,0 +1,14 @@ +--- +title: tutorial_complete +description: tutorial_complete +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies the user's completion of your on-boarding process. Use this in a funnel with `tutorial_begin` to understand how many users complete the tutorial. + +## Parameters + +No parameters are suggested for this event. diff --git a/website/docs/plugins/klaviyo-adapter.mdx b/website/docs/plugins/klaviyo-adapter.mdx new file mode 100644 index 0000000..850df7f --- /dev/null +++ b/website/docs/plugins/klaviyo-adapter.mdx @@ -0,0 +1,45 @@ +--- +title: KlaviyoAdapter +description: KlaviyoAdapter +hide_table_of_contents: true +--- + +The KlaviyoAdapter empowers you to seamlessly integrate Klaviyo event tracking within your @hyperse/track setup, leveraging the power of Klaviyo's robust data infrastructure for deeper customer insights and optimized marketing campaigns. + +**Key Features:** + +- **Unified Tracking:** Capture and send events to Klaviyo through a single, consistent interface, simplifying your tracking workflow. +- **TypeScript Typing:** Enjoy robust type safety and code completion through TypeScript definitions, ensuring accurate event data and reducing errors. +- **Effortless Integration:** Integrate the KlaviyoAdapter effortlessly into your @hyperse/track system, enabling fast and efficient tracking setup. +- **Comprehensive Event Tracking:** Track a wide range of events, including: + - **Viewed Product:** Track when users view specific products on your website. + - **Added to Cart:** Capture when users add items to their shopping carts. + - **Started Checkout:** Monitor when users initiate the checkout process. + - **Completed Order:** Track successful purchases and their associated revenue. + - **Customer Signup:** Track when users sign up for your email list or other marketing channels. + - **Custom Events:** Define and track your own custom events to capture specific actions on your website. + +**Benefits:** + +- **Enhanced Customer Segmentation:** Leverage detailed event data to segment your audience and personalize your marketing campaigns based on individual behavior and preferences. +- **Improved Email Marketing:** Optimize your email campaigns by sending targeted messages based on customer actions, resulting in higher engagement and conversion rates. +- **Data-Driven Insights:** Gain a deeper understanding of customer behavior and their interactions with your brand, enabling you to make informed decisions about your marketing strategy. +- **Streamlined Workflow:** Simplify your tracking setup and management with a unified solution for both Klaviyo and your @hyperse/track system, reducing complexity and streamlining your workflow. +- **Improved Code Quality:** TypeScript types ensure accurate event data and prevent potential errors, leading to more reliable tracking and a cleaner codebase. + +**With the KlaviyoAdapter, you can:** + +- **Personalize Customer Journeys:** Target your marketing messages based on individual customer behavior, delivering relevant content and offers. +- **Optimize Email Campaigns:** Use event data to segment your audience and create highly targeted email campaigns that resonate with specific customer groups. +- **Increase Customer Engagement:** Drive higher engagement with your brand by sending timely and personalized communications, enhancing the customer experience. +- **Boost Conversions:** Use data-driven insights to optimize your marketing strategy and drive more conversions, leading to increased revenue and business growth. + +**For a comprehensive guide on Klaviyo tracking and API integration, refer to the official documentation:** [https://developers.klaviyo.com/en](https://developers.klaviyo.com/en) + +**Embrace the power of Klaviyo and @hyperse/track with the KlaviyoAdapter. Unlock valuable data, optimize your marketing efforts, and drive better business outcomes.** + +## Install + +```bash npm2yarn +npm install @hyperse-hub/track-plugin-klaviyo --save +``` diff --git a/website/docs/plugins/klaviyo-events/clicked_banner.mdx b/website/docs/plugins/klaviyo-events/clicked_banner.mdx new file mode 100644 index 0000000..1bcd863 --- /dev/null +++ b/website/docs/plugins/klaviyo-events/clicked_banner.mdx @@ -0,0 +1,30 @@ +--- +title: clicked_banner +description: clicked_banner +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +The Clicked Banner event is used to track when someone clicks a banner on your site, allowing you to better target the users based on their click activity. This event can be used for any kind of banner as long as the user will be directed to a specific destination. + +## Parameters + +### source_url + + `string` + +The URL the user was at when they clicked the banner. + +### destination_url + + `string` + +The URL they navigated to by clicking on the banner. + +### banner_title + + `string` + +The banner title. diff --git a/website/docs/plugins/klaviyo-events/klaviyo_account.mdx b/website/docs/plugins/klaviyo-events/klaviyo_account.mdx new file mode 100644 index 0000000..e6d1dc8 --- /dev/null +++ b/website/docs/plugins/klaviyo-events/klaviyo_account.mdx @@ -0,0 +1,21 @@ +--- +title: klaviyo_account +description: klaviyo_account +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + + Klaviyo + + +If an `account_id` string is provided, it will set the account id. + +More information on the Klaviyo snippet can be found [Klaviyo](https://developers.klaviyo.com/en/docs/introduction_to_the_klaviyo_object) + +## Parameters + + `string` + +account_id diff --git a/website/docs/plugins/klaviyo-events/klaviyo_cookie_domain.mdx b/website/docs/plugins/klaviyo-events/klaviyo_cookie_domain.mdx new file mode 100644 index 0000000..6948a62 --- /dev/null +++ b/website/docs/plugins/klaviyo-events/klaviyo_cookie_domain.mdx @@ -0,0 +1,21 @@ +--- +title: klaviyo_cookie_domain +description: klaviyo_cookie_domain +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + + Klaviyo + + +If a cookieDomain string is provided, it will set the cookie domain. + +More information on the Klaviyo snippet can be found [Klaviyo](https://developers.klaviyo.com/en/docs/introduction_to_the_klaviyo_object#supported-methods) + +## Parameters + + `string` + +cookie domain diff --git a/website/docs/plugins/klaviyo-events/klaviyo_identify.mdx b/website/docs/plugins/klaviyo-events/klaviyo_identify.mdx new file mode 100644 index 0000000..6749afd --- /dev/null +++ b/website/docs/plugins/klaviyo-events/klaviyo_identify.mdx @@ -0,0 +1,19 @@ +--- +title: klaviyo_identify +description: klaviyo_identify +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + + Klaviyo + + +To start tracking people, add the snippet below to your website's main template so it will automatically be added to every page on your website. If you have a developer that will add this script to your website, you can send them a link to this guide. + +More information on the Klaviyo snippet can be found [Klaviyo](https://developers.klaviyo.com/en/docs/javascript_api#identify-people) + +## Parameters + +This parameter is optional and can be defined by users diff --git a/website/docs/plugins/klaviyo-events/klaviyo_open_form.mdx b/website/docs/plugins/klaviyo-events/klaviyo_open_form.mdx new file mode 100644 index 0000000..32fc901 --- /dev/null +++ b/website/docs/plugins/klaviyo-events/klaviyo_open_form.mdx @@ -0,0 +1,33 @@ +--- +title: klaviyo_open_form +description: klaviyo_open_form +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + + Klaviyo + + +Access the open form code + +More information on the Klaviyo snippet can be found [Klaviyo](https://developers.klaviyo.com/en/docs/how_to_custom_trigger_a_popup_or_flyout_form#customize-the-open-form-code) + +:::tip + +**It is important to note the following:** + +- Your form must be live in order for it to open. + +- When a form has an ongoing A/B test, this API simply triggers the form’s display. It is your A/B testing logic, which is separate, that determines which variation displays. + + If you have an A/B test where a variation of your form has a custom trigger, you will still need to add custom trigger code to your site. + +::: + +## Parameters + + `string` + +The FormID will be the ID of your form, which can be found at the end of the form editor URL. diff --git a/website/docs/plugins/klaviyo-events/klaviyo_track_viewed_item.mdx b/website/docs/plugins/klaviyo-events/klaviyo_track_viewed_item.mdx new file mode 100644 index 0000000..3cd66c9 --- /dev/null +++ b/website/docs/plugins/klaviyo-events/klaviyo_track_viewed_item.mdx @@ -0,0 +1,19 @@ +--- +title: klaviyo_track_viewed_item +description: klaviyo_track_viewed_item +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + + Klaviyo + + +There is another snippet that allows entries to be added to a “Recently Viewed Items” table for a profile. Calling the Klaviyo object's trackViewedItem function below will populate a product feed of recently viewed products that can be included in emails. For more information on how to use the “Recently Viewed Items” feature in a template + +More information on the Klaviyo snippet can be found [Klaviyo](https://developers.klaviyo.com/en/docs/guide_to_integrating_a_platform_without_a_pre_built_klaviyo_integration#viewed-product-tracking-snippet) + +## Parameters + +This parameter is optional and can be defined by users diff --git a/website/docs/plugins/klaviyo-events/referred_friend.mdx b/website/docs/plugins/klaviyo-events/referred_friend.mdx new file mode 100644 index 0000000..1aebd26 --- /dev/null +++ b/website/docs/plugins/klaviyo-events/referred_friend.mdx @@ -0,0 +1,24 @@ +--- +title: referred_friend +description: referred_friend +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +If you’d like to report on who’s referred your brand to a friend or send a thank you note to the person who referred you, you can track Referred Friend and Referred by Friend events. Similar to when someone shares content with a friend. + +## Parameters + +### recipients + + `string[]` + +The article recipient(s), identified by their email address. + +### quantity + + `number` + +The quantity of articles shared. diff --git a/website/docs/plugins/klaviyo-events/shared_article.mdx b/website/docs/plugins/klaviyo-events/shared_article.mdx new file mode 100644 index 0000000..b24bfe6 --- /dev/null +++ b/website/docs/plugins/klaviyo-events/shared_article.mdx @@ -0,0 +1,42 @@ +--- +title: shared_article +description: shared_article +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +When the article is initially shared, the Shared Article event uses our Track API to record the following information: + +## Parameters + +### recipients + + `string[]` + +The article recipient(s), identified by their email address (array of strings). + +### quantity + + `number` + +The quantity of articles shared. + +### name + + `string` + +The name of the article. + +### url + + `string` + +Article URL. + +### image_url + + `string` + +Identifying picture for article. diff --git a/website/docs/plugins/klaviyo-events/viewed_category.mdx b/website/docs/plugins/klaviyo-events/viewed_category.mdx new file mode 100644 index 0000000..85fe39b --- /dev/null +++ b/website/docs/plugins/klaviyo-events/viewed_category.mdx @@ -0,0 +1,36 @@ +--- +title: viewed_category +description: viewed_category +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +Similar to a Viewed Product event, the Viewed Category event allows you to capture when someone views a particular category of items, and triggers when a person lands on a category page. + +## Parameters + +### category_name + + `string` + +The category name. + +### category_id + + `string` + +The category ID. + +### image_url + + `string` + +The category image URL. + +### url + + `string` + +The category URL. diff --git a/website/docs/plugins/standard-events/add_payment_info.mdx b/website/docs/plugins/standard-events/add_payment_info.mdx new file mode 100644 index 0000000..7e006a7 --- /dev/null +++ b/website/docs/plugins/standard-events/add_payment_info.mdx @@ -0,0 +1,50 @@ +--- +title: add_payment_info +description: add_payment_info +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies a user has submitted their payment information in an ecommerce checkout process. + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### coupon + + `string` + +The coupon name/code associated with the event. + +Event-level and item-level coupon parameters are independent. + +### payment_type + + `string` + +Credit Card The chosen method of payment. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/standard-events/add_to_cart.mdx b/website/docs/plugins/standard-events/add_to_cart.mdx new file mode 100644 index 0000000..ad45502 --- /dev/null +++ b/website/docs/plugins/standard-events/add_to_cart.mdx @@ -0,0 +1,96 @@ +--- +title: add_to_cart +description: add_to_cart +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies that an item was added to a cart for purchase. + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. + +### added_item_product_name + + `string` + +The name of the product that was added to the cart. + +### added_item_product_id + + `string` + +The ID of the product that was added to the cart. + +### added_item_sku + + `string` + +The SKU of the product that was added to the cart. + +### added_item_categories + + `string[]` + +An array of categories for the product that was added to the cart. + +### added_item_image_url + + `string` + +The URL of the image for the product that was added to the cart. + +### added_item_url + + `string` + +The URL of the product that was added to the cart. + +### added_item_price + + `number` + +The price of the product that was added to the cart. + +### added_item_quantity + + `number` + +The quantity of the product that was added to the cart. + +### item_names + + `string[]` + +An array of product names in the cart. + +### checkout_url + + `string` + +The URL of the checkout page. diff --git a/website/docs/plugins/standard-events/add_to_wishlist.mdx b/website/docs/plugins/standard-events/add_to_wishlist.mdx new file mode 100644 index 0000000..b6bfdfe --- /dev/null +++ b/website/docs/plugins/standard-events/add_to_wishlist.mdx @@ -0,0 +1,36 @@ +--- +title: add_to_wishlist +description: add_to_wishlist +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +The event signifies that an item was added to a wishlist. Use this event to identify popular gift items in your app. + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/standard-events/begin_checkout.mdx b/website/docs/plugins/standard-events/begin_checkout.mdx new file mode 100644 index 0000000..70afdb1 --- /dev/null +++ b/website/docs/plugins/standard-events/begin_checkout.mdx @@ -0,0 +1,60 @@ +--- +title: begin_checkout +description: begin_checkout +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### coupon + + `string` + +The coupon name/code associated with the event. + +Event-level and item-level coupon parameters are independent. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. + +### item_names + + `string[]` + +An array of product names in the cart. + +### checkout_url + + `string` + +The URL of the checkout page. + +### categories + + `string` + +The URL of the categories. diff --git a/website/docs/plugins/standard-events/page_view.mdx b/website/docs/plugins/standard-events/page_view.mdx new file mode 100644 index 0000000..b860ad9 --- /dev/null +++ b/website/docs/plugins/standard-events/page_view.mdx @@ -0,0 +1,54 @@ +--- +title: page_view +description: page_view +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event indicates that the user viewed the web page. + +## Parameters + +### page_location + + `string` + +The URL of the page. + +### page_path + + `string` + +The path of the page. + +### client_id + + `string` + +The client ID. + +### language + + `string` + +The language used by the client. See language tags and codes. [LANGUAGE](https://en.wikipedia.org/wiki/Language_localisation#Language_tags_and_codes) + +### page_encoding + + `string` + +The encoding of the page. + +### page_title + + `string` + +The title of the page. + +### user_agent + + `string` + +The user agent of the client diff --git a/website/docs/plugins/standard-events/purchase.mdx b/website/docs/plugins/standard-events/purchase.mdx new file mode 100644 index 0000000..60a0468 --- /dev/null +++ b/website/docs/plugins/standard-events/purchase.mdx @@ -0,0 +1,64 @@ +--- +title: purchase +description: purchase +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies when one or more items is purchased by a user. + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### transaction_id + + `string` + +The unique identifier of a transaction. + +The `transaction_id` parameter helps you avoid getting duplicate events for a purchase. + +### coupon + + `string` + +The coupon name/code associated with the event. + +Event-level and item-level coupon parameters are independent. + +### shipping + + `number` + +Shipping cost associated with a transaction. + +### tax + + `number` + +Tax cost associated with a transaction. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/standard-events/search.mdx b/website/docs/plugins/standard-events/search.mdx new file mode 100644 index 0000000..d717ea9 --- /dev/null +++ b/website/docs/plugins/standard-events/search.mdx @@ -0,0 +1,24 @@ +--- +title: search +description: search +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +Log this event to indicate when the user has performed a search. You can use this event to identify what users are searching for on your website or app. For example, you could send this event when a user views a search results page after performing a search. + +## Parameters + +### search_term + + `string` + +The term that was searched for. + +### search_results_count + + `string` + +The number of search results. diff --git a/website/docs/plugins/standard-events/sign_up.mdx b/website/docs/plugins/standard-events/sign_up.mdx new file mode 100644 index 0000000..af58dfd --- /dev/null +++ b/website/docs/plugins/standard-events/sign_up.mdx @@ -0,0 +1,18 @@ +--- +title: sign_up +description: sign_up +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event indicates that a user has signed up for an account. Use this event to understand the different behaviors of logged in and logged out users. + +## Parameters + +### method + + `string` + +The method used for sign up. diff --git a/website/docs/plugins/standard-events/view_cart.mdx b/website/docs/plugins/standard-events/view_cart.mdx new file mode 100644 index 0000000..a60f6df --- /dev/null +++ b/website/docs/plugins/standard-events/view_cart.mdx @@ -0,0 +1,36 @@ +--- +title: view_cart +description: view_cart +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies that a user viewed their cart. + +## Parameters + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/standard-events/view_item.mdx b/website/docs/plugins/standard-events/view_item.mdx new file mode 100644 index 0000000..def5796 --- /dev/null +++ b/website/docs/plugins/standard-events/view_item.mdx @@ -0,0 +1,34 @@ +--- +title: view_item +description: view_item +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +This event signifies that some content was shown to the user. Use this event to discover the most popular items viewed. + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/standard-events/view_item_list.mdx b/website/docs/plugins/standard-events/view_item_list.mdx new file mode 100644 index 0000000..0884223 --- /dev/null +++ b/website/docs/plugins/standard-events/view_item_list.mdx @@ -0,0 +1,46 @@ +--- +title: view_item_list +description: view_item_list +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + + +Log this event when the user has been presented with a list of items of a certain category. + +### item_list_id + + `string` + +The ID of the list in which the item was presented to the user. + +### item_list_name + + `string` + +The name of the list in which the item was presented to the user. + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/standard-events/view_promotion.mdx b/website/docs/plugins/standard-events/view_promotion.mdx new file mode 100644 index 0000000..64908d0 --- /dev/null +++ b/website/docs/plugins/standard-events/view_promotion.mdx @@ -0,0 +1,63 @@ +--- +title: view_promotion +description: view_promotion +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + + +This event signifies a promotion was viewed from a list. + +### currency + + `string` + +USD Currency of the items associated with the event, in 3-letter ISO 4217 format. + +If you set value then currency is required for revenue metrics to be computed accurately. + +### value + + `number` + +The monetary value of the event. + +- Set value to the sum of (price \* quantity) for all items in items. Don't include shipping or tax. +- value is typically required for meaningful reporting. If you mark the event as a key event then it's recommended you set value. +- currency is required if you set value. + +### creative_name + + `string` + +The name of the promotional creative. + +### creative_slot + + `string` + +The name of the promotional creative slot associated with the event. + +### promotion_id + + `string` + +The ID of the promotion associated with the event. + +### promotion_name + + `string` + +The name of the promotion associated with the event. + +### location_id + + `string` + +The ID of the location. + +### items + + [Item](../types/standard-goods-item.mdx)[] + +The items for the event. diff --git a/website/docs/plugins/types/standard-goods-item.mdx b/website/docs/plugins/types/standard-goods-item.mdx new file mode 100644 index 0000000..f579ce9 --- /dev/null +++ b/website/docs/plugins/types/standard-goods-item.mdx @@ -0,0 +1,154 @@ +--- +title: standard_goods_item +description: standard_goods_item +hide_table_of_contents: false +toc_max_heading_level: 4 +--- + +# standard_goods_item + + + +Product details + +### Parameters + +- #### item_id + + `string` + + The ID of the item. + + One of item_id or item_name is required. + +- #### item_name + + `string` + + The name of the item. + + One of item_id or item_name is required. + +- #### affiliation + + `string` + + A product affiliation to designate a supplying company or brick and mortar store location. + +- #### coupon + + `string` + + The coupon name/code associated with the item. + + Event-level and item-level coupon parameters are independent. + +- #### discount + + `number` + + The unit monetary discount value associated with the item. + +- #### index + + `number` + + The index/position of the item in a list. + +- #### item_brand + + `string` + + The brand of the item. + +- #### item_category + + `string` + + The category of the item. If used as part of a category hierarchy or taxonomy then this will be the first category. + +- #### item_category2 + + `string` + + The second category hierarchy or additional taxonomy for the item. + +- #### item_category3 + + `string` + + The third category hierarchy or additional taxonomy for the item. + +- #### item_category4 + + `string` + + The fourth category hierarchy or additional taxonomy for the item. + +- #### item_category5 + + `string` + + The fifth category hierarchy or additional taxonomy for the item. + +- #### item_list_id + + `string` + + The ID of the list in which the item was presented to the user. + +- #### item_list_name + + `string` + + The name of the list in which the item was presented to the user. + +- #### item_variant + + `string` + + The item variant or unique code or description for additional item details/options. + +- #### location_id + + `string` + + The physical location associated with the item (e.g. the physical store location). It's recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. + +- #### price + + `number` + + 01 The monetary unit price of the item, in units of the specified currency parameter. + + If a discount applies to the item, set price to the discounted unit price and specify the unit price discount in the discount parameter. + +- #### quantity + + `number` + + Item quantity. + +- #### image_url + + `string` + + The URL of the product image. + +- #### url + + `string` + + The URL of the product page. + +- #### compare_at_price + + `number` + + The original price of the product, used for comparing with the current price. + +- #### row_total + + `number` + + The total price of the product based on quantity. diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index d27cb2f..3500546 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -1,5 +1,6 @@ import { themes } from 'prism-react-renderer'; import type * as Preset from '@docusaurus/preset-classic'; +import Mpm2yarn from '@docusaurus/remark-plugin-npm2yarn'; import type { Config } from '@docusaurus/types'; import type * as Plugin from '@docusaurus/types/src/plugin'; import { copyrightConfig } from './copyright.config'; @@ -15,6 +16,9 @@ const config: Config = { favicon: '/icon/favicon.svg', organizationName: 'Hyperse', projectName: 'hyperse tracker', + markdown: { + format: 'mdx', + }, presets: [ [ 'classic', @@ -23,6 +27,7 @@ const config: Config = { routeBasePath: '/docs', sidebarPath: './sidebars.ts', editUrl: 'https://github.com/hyperse-io/track', + remarkPlugins: [[Mpm2yarn, { sync: true }]], }, blog: false, theme: { @@ -69,6 +74,12 @@ const config: Config = { position: 'left', label: 'User Guide', }, + { + type: 'doc', + docId: 'plugins/google-adapter', + position: 'left', + label: 'Premium Plugins', + }, { href: 'https://www.npmjs.com/package/@hyperse/track', label: 'NPM', @@ -146,6 +157,7 @@ const config: Config = { return { name: 'docusaurus-tailwindcss', configurePostCss(postcssOptions) { + console.log(postcssOptions); // Appends TailwindCSS and AutoPrefixer. postcssOptions.plugins.push(require.resolve('tailwindcss')); postcssOptions.plugins.push(require.resolve('autoprefixer')); diff --git a/website/package.json b/website/package.json index fea5d3e..a3c6ff3 100644 --- a/website/package.json +++ b/website/package.json @@ -46,10 +46,11 @@ ] }, "dependencies": { - "@docusaurus/core": "^3.4.0", - "@docusaurus/plugin-content-docs": "^3.4.0", - "@docusaurus/plugin-google-gtag": "^3.4.0", - "@docusaurus/preset-classic": "^3.4.0", + "@docusaurus/core": "^3.5.2", + "@docusaurus/plugin-content-docs": "^3.5.2", + "@docusaurus/plugin-google-gtag": "^3.5.2", + "@docusaurus/preset-classic": "^3.5.2", + "@docusaurus/remark-plugin-npm2yarn": "^3.5.2", "@heroicons/react": "^2.1.5", "@mdx-js/react": "^3.0.1", "clsx": "^2.1.1", diff --git a/website/sidebars.ts b/website/sidebars.ts index d0aeb79..6c59336 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -60,17 +60,6 @@ const sidebars: SidebarsConfig = { }, ], }, - { - type: 'category', - label: 'Premium Plugins', - items: [ - { - type: 'doc', - id: 'adapters/google-adapter', - label: 'GoogleAdapter', - }, - ], - }, { type: 'category', label: 'Community', @@ -119,6 +108,79 @@ const sidebars: SidebarsConfig = { label: "FAQ's", }, ], + pluginsSidebar: [ + { + type: 'category', + label: 'Plugins', + items: [ + { + type: 'doc', + id: 'plugins/google-adapter', + label: 'GoogleAdapter', + }, + { + type: 'doc', + id: 'plugins/facebook-adapter', + label: 'FacebookAdapter', + }, + { + type: 'doc', + id: 'plugins/klaviyo-adapter', + label: 'KlaviyoAdapter', + }, + ], + }, + { + type: 'category', + label: 'Events', + items: [ + { + type: 'category', + label: 'Standard', + items: [ + { + type: 'autogenerated', + dirName: 'plugins/standard-events', + }, + { + type: 'autogenerated', + dirName: 'plugins/types', + }, + ], + }, + { + type: 'category', + label: 'Google', + items: [ + { + type: 'autogenerated', + dirName: 'plugins/google-events', + }, + ], + }, + { + type: 'category', + label: 'Facebook', + items: [ + { + type: 'autogenerated', + dirName: 'plugins/facebook-events', + }, + ], + }, + { + type: 'category', + label: 'Klaviyo', + items: [ + { + type: 'autogenerated', + dirName: 'plugins/klaviyo-events', + }, + ], + }, + ], + }, + ], }; export default sidebars; diff --git a/website/src/components/FlexLayout/index.tsx b/website/src/components/FlexLayout/index.tsx new file mode 100644 index 0000000..c35be95 --- /dev/null +++ b/website/src/components/FlexLayout/index.tsx @@ -0,0 +1,21 @@ +import React, { FC } from 'react'; +import { clsx } from 'clsx'; + +export interface FlexLayoutProps { + children: React.ReactNode; + deration?: 'row' | 'column'; +} + +export const FlexLayout: FC = (props) => { + const { deration = 'row' } = props; + return ( +
+ {props.children} +
+ ); +}; diff --git a/website/src/components/NpmLink/index.tsx b/website/src/components/NpmLink/index.tsx new file mode 100644 index 0000000..4f76469 --- /dev/null +++ b/website/src/components/NpmLink/index.tsx @@ -0,0 +1,50 @@ +import React, { FC } from 'react'; +import clsx from 'clsx'; + +export const BaseNpmUrl = 'https://registry.hyperse.net/package/'; + +export const NpmLinkMap = { + common: '@hyperse-hub/track-plugin-common', + google: '@hyperse-hub/track-plugin-google', + facebook: '@hyperse-hub/track-plugin-facebook', + klaviyo: '@hyperse-hub/track-plugin-klaviyo', +}; + +export interface NpmLinkProps { + name: keyof typeof NpmLinkMap; + className?: React.CSSProperties; + noMarginBottom?: boolean; +} + +export const NpmLink: FC = (props) => { + const url = NpmLinkMap[props.name]; + return ( + + + + + + {NpmLinkMap[props.name]} + + ); +}; diff --git a/website/src/components/Platform/index.tsx b/website/src/components/Platform/index.tsx new file mode 100644 index 0000000..92f3c08 --- /dev/null +++ b/website/src/components/Platform/index.tsx @@ -0,0 +1,36 @@ +import React, { FC } from 'react'; + +export interface PlatformProps { + children?: React.ReactNode; +} + +export const Platform: FC = (props) => { + return ( + { + alert( + `The current field is only valid for ${props.children}, other platforms will automatically eliminate or reduce to additional parameters` + ); + }} + > + Platform + + {props.children} + + + + + + + ); +}; diff --git a/website/src/components/Property/index.tsx b/website/src/components/Property/index.tsx new file mode 100644 index 0000000..a29c0ca --- /dev/null +++ b/website/src/components/Property/index.tsx @@ -0,0 +1,9 @@ +import React from 'react'; + +export const Property = () => { + return ( + + Property + + ); +}; diff --git a/website/src/components/Required/index.tsx b/website/src/components/Required/index.tsx new file mode 100644 index 0000000..b3e7c77 --- /dev/null +++ b/website/src/components/Required/index.tsx @@ -0,0 +1,21 @@ +import React, { FC } from 'react'; + +export interface RequiredProps { + required?: boolean; +} + +export const Required: FC = (props) => { + const { required = false } = props; + if (!required) { + return ( + + Optional + + ); + } + return ( + + required + + ); +}; diff --git a/website/src/theme/MDXComponents.js b/website/src/theme/MDXComponents.js new file mode 100644 index 0000000..000104e --- /dev/null +++ b/website/src/theme/MDXComponents.js @@ -0,0 +1,15 @@ +import { FlexLayout } from '@site/src/components/FlexLayout'; +import { NpmLink } from '@site/src/components/NpmLink'; +import { Platform } from '@site/src/components/Platform'; +import { Property } from '@site/src/components/Property'; +import { Required } from '@site/src/components/Required'; +import MDXComponents from '@theme-original/MDXComponents'; + +export default { + ...MDXComponents, + Required, + Property, + NpmLink, + Platform, + FlexLayout, +}; diff --git a/yarn.lock b/yarn.lock index 79bf794..75b032c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2266,7 +2266,7 @@ __metadata: languageName: node linkType: hard -"@docusaurus/core@npm:3.4.0, @docusaurus/core@npm:^3.4.0": +"@docusaurus/core@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/core@npm:3.4.0" dependencies: @@ -2347,6 +2347,88 @@ __metadata: languageName: node linkType: hard +"@docusaurus/core@npm:3.5.2, @docusaurus/core@npm:^3.5.2": + version: 3.5.2 + resolution: "@docusaurus/core@npm:3.5.2" + dependencies: + "@babel/core": "npm:^7.23.3" + "@babel/generator": "npm:^7.23.3" + "@babel/plugin-syntax-dynamic-import": "npm:^7.8.3" + "@babel/plugin-transform-runtime": "npm:^7.22.9" + "@babel/preset-env": "npm:^7.22.9" + "@babel/preset-react": "npm:^7.22.5" + "@babel/preset-typescript": "npm:^7.22.5" + "@babel/runtime": "npm:^7.22.6" + "@babel/runtime-corejs3": "npm:^7.22.6" + "@babel/traverse": "npm:^7.22.8" + "@docusaurus/cssnano-preset": "npm:3.5.2" + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/mdx-loader": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" + autoprefixer: "npm:^10.4.14" + babel-loader: "npm:^9.1.3" + babel-plugin-dynamic-import-node: "npm:^2.3.3" + boxen: "npm:^6.2.1" + chalk: "npm:^4.1.2" + chokidar: "npm:^3.5.3" + clean-css: "npm:^5.3.2" + cli-table3: "npm:^0.6.3" + combine-promises: "npm:^1.1.0" + commander: "npm:^5.1.0" + copy-webpack-plugin: "npm:^11.0.0" + core-js: "npm:^3.31.1" + css-loader: "npm:^6.8.1" + css-minimizer-webpack-plugin: "npm:^5.0.1" + cssnano: "npm:^6.1.2" + del: "npm:^6.1.1" + detect-port: "npm:^1.5.1" + escape-html: "npm:^1.0.3" + eta: "npm:^2.2.0" + eval: "npm:^0.1.8" + file-loader: "npm:^6.2.0" + fs-extra: "npm:^11.1.1" + html-minifier-terser: "npm:^7.2.0" + html-tags: "npm:^3.3.1" + html-webpack-plugin: "npm:^5.5.3" + leven: "npm:^3.1.0" + lodash: "npm:^4.17.21" + mini-css-extract-plugin: "npm:^2.7.6" + p-map: "npm:^4.0.0" + postcss: "npm:^8.4.26" + postcss-loader: "npm:^7.3.3" + prompts: "npm:^2.4.2" + react-dev-utils: "npm:^12.0.1" + react-helmet-async: "npm:^1.3.0" + react-loadable: "npm:@docusaurus/react-loadable@6.0.0" + react-loadable-ssr-addon-v5-slorber: "npm:^1.0.1" + react-router: "npm:^5.3.4" + react-router-config: "npm:^5.1.1" + react-router-dom: "npm:^5.3.4" + rtl-detect: "npm:^1.0.4" + semver: "npm:^7.5.4" + serve-handler: "npm:^6.1.5" + shelljs: "npm:^0.8.5" + terser-webpack-plugin: "npm:^5.3.9" + tslib: "npm:^2.6.0" + update-notifier: "npm:^6.0.2" + url-loader: "npm:^4.1.1" + webpack: "npm:^5.88.1" + webpack-bundle-analyzer: "npm:^4.9.0" + webpack-dev-server: "npm:^4.15.1" + webpack-merge: "npm:^5.9.0" + webpackbar: "npm:^5.0.2" + peerDependencies: + "@mdx-js/react": ^3.0.0 + react: ^18.0.0 + react-dom: ^18.0.0 + bin: + docusaurus: bin/docusaurus.mjs + checksum: 10/4515fe7502ad9912c2d25b7b1ec56196d4f96fc5b4702f6f8551ab2b3dbd0e6286f789e3663ceb8e95b31af0816817b0b35a7fb230a0c950b7e2802f30966442 + languageName: node + linkType: hard + "@docusaurus/cssnano-preset@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/cssnano-preset@npm:3.4.0" @@ -2359,6 +2441,18 @@ __metadata: languageName: node linkType: hard +"@docusaurus/cssnano-preset@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/cssnano-preset@npm:3.5.2" + dependencies: + cssnano-preset-advanced: "npm:^6.1.2" + postcss: "npm:^8.4.38" + postcss-sort-media-queries: "npm:^5.2.0" + tslib: "npm:^2.6.0" + checksum: 10/4bb1fae3741e14cbbdb64c1b0707435970838bf219831234a70cf382e6811ffac1cadf733d5e1fe7c278e7b2a9e533bfa802a5212b22ec46edd703208cf49f92 + languageName: node + linkType: hard + "@docusaurus/logger@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/logger@npm:3.4.0" @@ -2369,6 +2463,16 @@ __metadata: languageName: node linkType: hard +"@docusaurus/logger@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/logger@npm:3.5.2" + dependencies: + chalk: "npm:^4.1.2" + tslib: "npm:^2.6.0" + checksum: 10/9cc1ac17503fdd739ceba6340289bf39740e1aad87e0a7e5da97fcd2f6186b5f4da05bbbbf660a43af04f0ec8bc2aaac086d6d31c79ab64c71acb3da36213b9e + languageName: node + linkType: hard + "@docusaurus/mdx-loader@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/mdx-loader@npm:3.4.0" @@ -2404,6 +2508,41 @@ __metadata: languageName: node linkType: hard +"@docusaurus/mdx-loader@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/mdx-loader@npm:3.5.2" + dependencies: + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" + "@mdx-js/mdx": "npm:^3.0.0" + "@slorber/remark-comment": "npm:^1.0.0" + escape-html: "npm:^1.0.3" + estree-util-value-to-estree: "npm:^3.0.1" + file-loader: "npm:^6.2.0" + fs-extra: "npm:^11.1.1" + image-size: "npm:^1.0.2" + mdast-util-mdx: "npm:^3.0.0" + mdast-util-to-string: "npm:^4.0.0" + rehype-raw: "npm:^7.0.0" + remark-directive: "npm:^3.0.0" + remark-emoji: "npm:^4.0.0" + remark-frontmatter: "npm:^5.0.0" + remark-gfm: "npm:^4.0.0" + stringify-object: "npm:^3.3.0" + tslib: "npm:^2.6.0" + unified: "npm:^11.0.3" + unist-util-visit: "npm:^5.0.0" + url-loader: "npm:^4.1.1" + vfile: "npm:^6.0.1" + webpack: "npm:^5.88.1" + peerDependencies: + react: ^18.0.0 + react-dom: ^18.0.0 + checksum: 10/9d9f771c1af1d285e182c2966159d4d0904fae563d7ce0e4e3d5fbf2a98555721252a32d1acd4f971f0a5fca90929906fd1ad9c005c7ec9306801c11b3c64ffc + languageName: node + linkType: hard + "@docusaurus/module-type-aliases@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/module-type-aliases@npm:3.4.0" @@ -2422,18 +2561,37 @@ __metadata: languageName: node linkType: hard -"@docusaurus/plugin-content-blog@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/plugin-content-blog@npm:3.4.0" +"@docusaurus/module-type-aliases@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/module-type-aliases@npm:3.5.2" dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/logger": "npm:3.4.0" - "@docusaurus/mdx-loader": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" - "@docusaurus/utils": "npm:3.4.0" - "@docusaurus/utils-common": "npm:3.4.0" - "@docusaurus/utils-validation": "npm:3.4.0" - cheerio: "npm:^1.0.0-rc.12" + "@docusaurus/types": "npm:3.5.2" + "@types/history": "npm:^4.7.11" + "@types/react": "npm:*" + "@types/react-router-config": "npm:*" + "@types/react-router-dom": "npm:*" + react-helmet-async: "npm:*" + react-loadable: "npm:@docusaurus/react-loadable@6.0.0" + peerDependencies: + react: "*" + react-dom: "*" + checksum: 10/48d7b8a1f4fb946d541cff312a953149692bd6590e0ee2e6877b6903f7cb1871c6e79dfcaad465bd24201388d58a85a7a49c53d95f6f51d51bd1ae49d37020f2 + languageName: node + linkType: hard + +"@docusaurus/plugin-content-blog@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-content-blog@npm:3.5.2" + dependencies: + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/mdx-loader": "npm:3.5.2" + "@docusaurus/theme-common": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" + cheerio: "npm:1.0.0-rc.12" feed: "npm:^4.2.2" fs-extra: "npm:^11.1.1" lodash: "npm:^4.17.21" @@ -2444,13 +2602,14 @@ __metadata: utility-types: "npm:^3.10.0" webpack: "npm:^5.88.1" peerDependencies: + "@docusaurus/plugin-content-docs": "*" react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/27bc3b6fc4d20667014d2efd8a6c69ac8ec55739807be39830e055a03334bae490f22caa891b700003446ddfa6cc1460d244eeb016d9cf5c5da78eeb253d0f90 + checksum: 10/42429c6d9182e6fb6699eefb016597be11718859bda9a107aaa226c67bda08a3f567952be72b04f71ded7e18bd3513380aa42466b960495c8219db3f1b0b3c83 languageName: node linkType: hard -"@docusaurus/plugin-content-docs@npm:3.4.0, @docusaurus/plugin-content-docs@npm:^3.4.0": +"@docusaurus/plugin-content-docs@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/plugin-content-docs@npm:3.4.0" dependencies: @@ -2477,152 +2636,193 @@ __metadata: languageName: node linkType: hard -"@docusaurus/plugin-content-pages@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/plugin-content-pages@npm:3.4.0" +"@docusaurus/plugin-content-docs@npm:3.5.2, @docusaurus/plugin-content-docs@npm:^3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-content-docs@npm:3.5.2" + dependencies: + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/mdx-loader": "npm:3.5.2" + "@docusaurus/module-type-aliases": "npm:3.5.2" + "@docusaurus/theme-common": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" + "@types/react-router-config": "npm:^5.0.7" + combine-promises: "npm:^1.1.0" + fs-extra: "npm:^11.1.1" + js-yaml: "npm:^4.1.0" + lodash: "npm:^4.17.21" + tslib: "npm:^2.6.0" + utility-types: "npm:^3.10.0" + webpack: "npm:^5.88.1" + peerDependencies: + react: ^18.0.0 + react-dom: ^18.0.0 + checksum: 10/100250c4e988de1f31cf5bc1fd9f6b6929ccfbb748113352bf5ac4b90ed2f096cb4366d95451a367d26d79735879711f0ec1eae352a7829c0f5e40443c873d6f + languageName: node + linkType: hard + +"@docusaurus/plugin-content-pages@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-content-pages@npm:3.5.2" dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/mdx-loader": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" - "@docusaurus/utils": "npm:3.4.0" - "@docusaurus/utils-validation": "npm:3.4.0" + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/mdx-loader": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" fs-extra: "npm:^11.1.1" tslib: "npm:^2.6.0" webpack: "npm:^5.88.1" peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/6fbea942a147836af2320f47e1e5753cb7129fdab211055f35d95e43eb2be60c19bc01657f41da1641028ce708550c3c7698510df50ae79812fa053de111a8c3 + checksum: 10/f89fdd30d4c4e6e750c6814f28eb21f6886d4e5f6c56bbfb14fc518262b19406222da48ab7884dce0dd599045d6325ae89a02a16a807df60b8d52aa27cdb4e8b languageName: node linkType: hard -"@docusaurus/plugin-debug@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/plugin-debug@npm:3.4.0" +"@docusaurus/plugin-debug@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-debug@npm:3.5.2" dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" - "@docusaurus/utils": "npm:3.4.0" + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" fs-extra: "npm:^11.1.1" react-json-view-lite: "npm:^1.2.0" tslib: "npm:^2.6.0" peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/f07caeed0608a62c447b1a495e48fa8fcc8248d9c385887e2e814bb7610ff09b4ab2d7b10ba8ecc5024880a4e37d958fcd99aa4684406a946d92121ab94149c1 + checksum: 10/a839e6c3a595ea202fdd7fbce638ab8df26ba73a8c7ead8c04d1bbb509ebe34e9633e7fe9eb54a7a733e93a03d74a60df4d9f6597b9621ff464280d4dd71db34 languageName: node linkType: hard -"@docusaurus/plugin-google-analytics@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/plugin-google-analytics@npm:3.4.0" +"@docusaurus/plugin-google-analytics@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-google-analytics@npm:3.5.2" dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" - "@docusaurus/utils-validation": "npm:3.4.0" + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" tslib: "npm:^2.6.0" peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/ade51012397c12dbe7d0563ad7b2e345e3acbbd7729bf490b6d0f0cc2527b91abdd41b31392786c4697591d5b1f066f9ad257f483deaa2f2ea5194e33e3cd821 + checksum: 10/0b8c4d21333d40c2509d6ef807caaf69f085010c5deac514ab34f53b5486fd76766c90213dc98976a6c4d66fdfa14bf6b05594e51e8a53ec60c2a3fa08fd9a83 languageName: node linkType: hard -"@docusaurus/plugin-google-gtag@npm:3.4.0, @docusaurus/plugin-google-gtag@npm:^3.4.0": - version: 3.4.0 - resolution: "@docusaurus/plugin-google-gtag@npm:3.4.0" +"@docusaurus/plugin-google-gtag@npm:3.5.2, @docusaurus/plugin-google-gtag@npm:^3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-google-gtag@npm:3.5.2" dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" - "@docusaurus/utils-validation": "npm:3.4.0" + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" "@types/gtag.js": "npm:^0.0.12" tslib: "npm:^2.6.0" peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/bab50eecf16d41b3a6896f0f222477495be63a195d012725042df6ea43a25281ca6929422b3b1ca901ae4127cf2000c05432afd01c69430fe973dc5a9ad35b9d + checksum: 10/5d53c2483c8c7e3a8e842bd091a774d4041f0e165d216b3c02f031a224a77258c9456e8b2acd0500b4a0eff474a83c1b82803628db9d4b132514409936c68ac4 languageName: node linkType: hard -"@docusaurus/plugin-google-tag-manager@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/plugin-google-tag-manager@npm:3.4.0" +"@docusaurus/plugin-google-tag-manager@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-google-tag-manager@npm:3.5.2" dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" - "@docusaurus/utils-validation": "npm:3.4.0" + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" tslib: "npm:^2.6.0" peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/0b3e98856b81d66ba756fb2504bf54dbe24372fca0b4c298b6e83339be7c7c970c759bce3a4321b73c117d5eeef962f3395651100832bb3618f6cdb87f133b15 + checksum: 10/9a6fc2ca54ea677c6edfd78f4f392d7d9ae86afd085fcda96d5ac41efa441352c25a2519595d9d15fb9b838e2ae39837f0daf02e2406c5cd56199ae237bd7b7a languageName: node linkType: hard -"@docusaurus/plugin-sitemap@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/plugin-sitemap@npm:3.4.0" - dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/logger": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" - "@docusaurus/utils": "npm:3.4.0" - "@docusaurus/utils-common": "npm:3.4.0" - "@docusaurus/utils-validation": "npm:3.4.0" +"@docusaurus/plugin-sitemap@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-sitemap@npm:3.5.2" + dependencies: + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" fs-extra: "npm:^11.1.1" sitemap: "npm:^7.1.1" tslib: "npm:^2.6.0" peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/23f4821d88f167ebcd9001e721b32c8c43fc049086aac10eaf3c0a79c992a6787de4533b1526ad060cc55d1eecd60c593e2b7e7457850b862be93108e3cdb97c + checksum: 10/74d17206fdf7fb1fe826e0876b71f0e404e115e98a71fe34a1b0ce607e84b285dfd0f5995bab53eeff2e32ee3f03ae5c27d9337bd8cab9108f55bcbb2f5d9333 languageName: node linkType: hard -"@docusaurus/preset-classic@npm:^3.4.0": - version: 3.4.0 - resolution: "@docusaurus/preset-classic@npm:3.4.0" - dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/plugin-content-blog": "npm:3.4.0" - "@docusaurus/plugin-content-docs": "npm:3.4.0" - "@docusaurus/plugin-content-pages": "npm:3.4.0" - "@docusaurus/plugin-debug": "npm:3.4.0" - "@docusaurus/plugin-google-analytics": "npm:3.4.0" - "@docusaurus/plugin-google-gtag": "npm:3.4.0" - "@docusaurus/plugin-google-tag-manager": "npm:3.4.0" - "@docusaurus/plugin-sitemap": "npm:3.4.0" - "@docusaurus/theme-classic": "npm:3.4.0" - "@docusaurus/theme-common": "npm:3.4.0" - "@docusaurus/theme-search-algolia": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" +"@docusaurus/preset-classic@npm:^3.5.2": + version: 3.5.2 + resolution: "@docusaurus/preset-classic@npm:3.5.2" + dependencies: + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/plugin-content-blog": "npm:3.5.2" + "@docusaurus/plugin-content-docs": "npm:3.5.2" + "@docusaurus/plugin-content-pages": "npm:3.5.2" + "@docusaurus/plugin-debug": "npm:3.5.2" + "@docusaurus/plugin-google-analytics": "npm:3.5.2" + "@docusaurus/plugin-google-gtag": "npm:3.5.2" + "@docusaurus/plugin-google-tag-manager": "npm:3.5.2" + "@docusaurus/plugin-sitemap": "npm:3.5.2" + "@docusaurus/theme-classic": "npm:3.5.2" + "@docusaurus/theme-common": "npm:3.5.2" + "@docusaurus/theme-search-algolia": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/968833af162303685bebce71baed4ae662ce4c67957ceba0c9d697459c5e7996455a8a7ecb1b5c1a5978b475d5aa71605f8ec6b5b90459940310ffb2f4f5b6f1 + checksum: 10/ec578e62b3b13b1874b14235a448a913c2d2358ea9b9d9c60bb250be468ab62387c88ec44e1ee82ad5b3d7243306e31919888a80eae62e5e8eab0ae12194bf69 languageName: node linkType: hard -"@docusaurus/theme-classic@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/theme-classic@npm:3.4.0" +"@docusaurus/remark-plugin-npm2yarn@npm:^3.5.2": + version: 3.5.2 + resolution: "@docusaurus/remark-plugin-npm2yarn@npm:3.5.2" dependencies: - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/mdx-loader": "npm:3.4.0" - "@docusaurus/module-type-aliases": "npm:3.4.0" - "@docusaurus/plugin-content-blog": "npm:3.4.0" - "@docusaurus/plugin-content-docs": "npm:3.4.0" - "@docusaurus/plugin-content-pages": "npm:3.4.0" - "@docusaurus/theme-common": "npm:3.4.0" - "@docusaurus/theme-translations": "npm:3.4.0" - "@docusaurus/types": "npm:3.4.0" - "@docusaurus/utils": "npm:3.4.0" - "@docusaurus/utils-common": "npm:3.4.0" - "@docusaurus/utils-validation": "npm:3.4.0" + mdast-util-mdx: "npm:^3.0.0" + npm-to-yarn: "npm:^2.2.1" + tslib: "npm:^2.6.0" + unified: "npm:^11.0.3" + unist-util-visit: "npm:^5.0.0" + checksum: 10/11fc992183650418ef56c72d4e36fc41407401a2de01e1d40d8ed436efbade10e9bcd1f93858d6760d0f3fa55c5db807fd80a05e870416700676f0bc0825258e + languageName: node + linkType: hard + +"@docusaurus/theme-classic@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/theme-classic@npm:3.5.2" + dependencies: + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/mdx-loader": "npm:3.5.2" + "@docusaurus/module-type-aliases": "npm:3.5.2" + "@docusaurus/plugin-content-blog": "npm:3.5.2" + "@docusaurus/plugin-content-docs": "npm:3.5.2" + "@docusaurus/plugin-content-pages": "npm:3.5.2" + "@docusaurus/theme-common": "npm:3.5.2" + "@docusaurus/theme-translations": "npm:3.5.2" + "@docusaurus/types": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" "@mdx-js/react": "npm:^3.0.0" clsx: "npm:^2.0.0" copy-text-to-clipboard: "npm:^3.2.0" - infima: "npm:0.2.0-alpha.43" + infima: "npm:0.2.0-alpha.44" lodash: "npm:^4.17.21" nprogress: "npm:^0.2.0" postcss: "npm:^8.4.26" @@ -2635,21 +2835,18 @@ __metadata: peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/5c9e63797caa8123a8baf3f68b44ad03dab3f2c17c272c89e70fd8cd67be80c9bc979dff9ca7084fe47420ff6736b49da5b56a9ca5a6fb442f3df765b5af923c + checksum: 10/74a4bf64ba6699ebb3adea29d7c57996b032a6d77e4b650dcf68b8af7d6152a3712354dd964eab674a189d582ffbde50037cec8c0cf6369da267c37e5856eb2b languageName: node linkType: hard -"@docusaurus/theme-common@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/theme-common@npm:3.4.0" +"@docusaurus/theme-common@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/theme-common@npm:3.5.2" dependencies: - "@docusaurus/mdx-loader": "npm:3.4.0" - "@docusaurus/module-type-aliases": "npm:3.4.0" - "@docusaurus/plugin-content-blog": "npm:3.4.0" - "@docusaurus/plugin-content-docs": "npm:3.4.0" - "@docusaurus/plugin-content-pages": "npm:3.4.0" - "@docusaurus/utils": "npm:3.4.0" - "@docusaurus/utils-common": "npm:3.4.0" + "@docusaurus/mdx-loader": "npm:3.5.2" + "@docusaurus/module-type-aliases": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" "@types/history": "npm:^4.7.11" "@types/react": "npm:*" "@types/react-router-config": "npm:*" @@ -2659,24 +2856,25 @@ __metadata: tslib: "npm:^2.6.0" utility-types: "npm:^3.10.0" peerDependencies: + "@docusaurus/plugin-content-docs": "*" react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/6a815feb6ae8ee5fb76ed76b10f826d8aa864926a31607ff7bff39ad5e1d95b215eec05acd66b9db667a8575c0283d90a373c52bb4d7262b02b69dd76932a534 + checksum: 10/1cb8f97516f152f3b4a747926e9c1a22dc1be5ffc8cfe1a3b0ac5a3bdaaa749b61fb34dbf4c0cb03e319b2cc9ea5c12b39dedcd869721cd2ad8d19be82e015f9 languageName: node linkType: hard -"@docusaurus/theme-search-algolia@npm:3.4.0": - version: 3.4.0 - resolution: "@docusaurus/theme-search-algolia@npm:3.4.0" +"@docusaurus/theme-search-algolia@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/theme-search-algolia@npm:3.5.2" dependencies: "@docsearch/react": "npm:^3.5.2" - "@docusaurus/core": "npm:3.4.0" - "@docusaurus/logger": "npm:3.4.0" - "@docusaurus/plugin-content-docs": "npm:3.4.0" - "@docusaurus/theme-common": "npm:3.4.0" - "@docusaurus/theme-translations": "npm:3.4.0" - "@docusaurus/utils": "npm:3.4.0" - "@docusaurus/utils-validation": "npm:3.4.0" + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/plugin-content-docs": "npm:3.5.2" + "@docusaurus/theme-common": "npm:3.5.2" + "@docusaurus/theme-translations": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" algoliasearch: "npm:^4.18.0" algoliasearch-helper: "npm:^3.13.3" clsx: "npm:^2.0.0" @@ -2688,7 +2886,7 @@ __metadata: peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/80437afd52d10a41bdbed818654b0ead643e9fcf736f4a556ce1f882e865d0dee88d81b161f41b9c40b87db0c42d8b3b48841194e28cb0c826cc2f66475b3628 + checksum: 10/24e9378dec5ec91d1f2a6e539182d2424bbf14d60e92db180870716e3c7327931d4aab912a8251e18323395bd5b9a10f97f9af87e88a962ef691903fb9f3d7be languageName: node linkType: hard @@ -2702,6 +2900,16 @@ __metadata: languageName: node linkType: hard +"@docusaurus/theme-translations@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/theme-translations@npm:3.5.2" + dependencies: + fs-extra: "npm:^11.1.1" + tslib: "npm:^2.6.0" + checksum: 10/f89d7d87b4fb2fd43e286c557d9fa830d06a369516cd6c26d43afd7ab4d92c57be47c2ca8bf5779c150193511bab439237e6d2901e637a8c094955de34f9a044 + languageName: node + linkType: hard + "@docusaurus/types@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/types@npm:3.4.0" @@ -2722,6 +2930,26 @@ __metadata: languageName: node linkType: hard +"@docusaurus/types@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/types@npm:3.5.2" + dependencies: + "@mdx-js/mdx": "npm:^3.0.0" + "@types/history": "npm:^4.7.11" + "@types/react": "npm:*" + commander: "npm:^5.1.0" + joi: "npm:^17.9.2" + react-helmet-async: "npm:^1.3.0" + utility-types: "npm:^3.10.0" + webpack: "npm:^5.88.1" + webpack-merge: "npm:^5.9.0" + peerDependencies: + react: ^18.0.0 + react-dom: ^18.0.0 + checksum: 10/d13193916812312ae06d0e193c9f5d778948a6f1635d03b381b06a10d12f6479394e617fc5ef5b028fd7a155090d366b6ccd15b5552895645be2fede880faf0b + languageName: node + linkType: hard + "@docusaurus/utils-common@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/utils-common@npm:3.4.0" @@ -2736,6 +2964,20 @@ __metadata: languageName: node linkType: hard +"@docusaurus/utils-common@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/utils-common@npm:3.5.2" + dependencies: + tslib: "npm:^2.6.0" + peerDependencies: + "@docusaurus/types": "*" + peerDependenciesMeta: + "@docusaurus/types": + optional: true + checksum: 10/9d550c89663d4271456ae0832c82a1691207ccc95e21df3a05a4bd6bbd2624bb9e3ab7327d939c04b2023378987bcf99321b2c37be1af214852832f65d6db14a + languageName: node + linkType: hard + "@docusaurus/utils-validation@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/utils-validation@npm:3.4.0" @@ -2752,6 +2994,22 @@ __metadata: languageName: node linkType: hard +"@docusaurus/utils-validation@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/utils-validation@npm:3.5.2" + dependencies: + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" + fs-extra: "npm:^11.2.0" + joi: "npm:^17.9.2" + js-yaml: "npm:^4.1.0" + lodash: "npm:^4.17.21" + tslib: "npm:^2.6.0" + checksum: 10/636a5c0d3543c6bd64a844e4ff365afbba270ab7722a6b22c64384939ce952d88df72000e7d47e80adf312810fbb501c20c7afdbfa755b19ecbda31c26073dd0 + languageName: node + linkType: hard + "@docusaurus/utils@npm:3.4.0": version: 3.4.0 resolution: "@docusaurus/utils@npm:3.4.0" @@ -2785,6 +3043,39 @@ __metadata: languageName: node linkType: hard +"@docusaurus/utils@npm:3.5.2": + version: 3.5.2 + resolution: "@docusaurus/utils@npm:3.5.2" + dependencies: + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" + "@svgr/webpack": "npm:^8.1.0" + escape-string-regexp: "npm:^4.0.0" + file-loader: "npm:^6.2.0" + fs-extra: "npm:^11.1.1" + github-slugger: "npm:^1.5.0" + globby: "npm:^11.1.0" + gray-matter: "npm:^4.0.3" + jiti: "npm:^1.20.0" + js-yaml: "npm:^4.1.0" + lodash: "npm:^4.17.21" + micromatch: "npm:^4.0.5" + prompts: "npm:^2.4.2" + resolve-pathname: "npm:^3.0.0" + shelljs: "npm:^0.8.5" + tslib: "npm:^2.6.0" + url-loader: "npm:^4.1.1" + utility-types: "npm:^3.10.0" + webpack: "npm:^5.88.1" + peerDependencies: + "@docusaurus/types": "*" + peerDependenciesMeta: + "@docusaurus/types": + optional: true + checksum: 10/93355851b49de217d21f9a31d5e4083bd2b1b761af438fed5eb49c3890f01aba4bcb1801f1cd69e440ef88aa29b81783479c22302ad08a061fb1b559659e34e6 + languageName: node + linkType: hard + "@esbuild/aix-ppc64@npm:0.21.5": version: 0.21.5 resolution: "@esbuild/aix-ppc64@npm:0.21.5" @@ -3308,11 +3599,12 @@ __metadata: "@changesets/cli": "npm:2.27.7" "@commitlint/cli": "npm:19.3.0" "@commitlint/config-conventional": "npm:19.2.2" - "@docusaurus/core": "npm:^3.4.0" + "@docusaurus/core": "npm:^3.5.2" "@docusaurus/module-type-aliases": "npm:3.4.0" - "@docusaurus/plugin-content-docs": "npm:^3.4.0" - "@docusaurus/plugin-google-gtag": "npm:^3.4.0" - "@docusaurus/preset-classic": "npm:^3.4.0" + "@docusaurus/plugin-content-docs": "npm:^3.5.2" + "@docusaurus/plugin-google-gtag": "npm:^3.5.2" + "@docusaurus/preset-classic": "npm:^3.5.2" + "@docusaurus/remark-plugin-npm2yarn": "npm:^3.5.2" "@heroicons/react": "npm:^2.1.5" "@hyperse/eslint-config-hyperse": "npm:^1.0.12" "@mdx-js/react": "npm:^3.0.1" @@ -6504,7 +6796,7 @@ __metadata: languageName: node linkType: hard -"cheerio@npm:^1.0.0-rc.12": +"cheerio@npm:1.0.0-rc.12": version: 1.0.0-rc.12 resolution: "cheerio@npm:1.0.0-rc.12" dependencies: @@ -10740,10 +11032,10 @@ __metadata: languageName: node linkType: hard -"infima@npm:0.2.0-alpha.43": - version: 0.2.0-alpha.43 - resolution: "infima@npm:0.2.0-alpha.43" - checksum: 10/24795341f333331a9525eb560b131ba7842278ce6542c913964b55554b9c30364e8c34ed5b31daaed13044cb31f3f1c2d3c2109c653a242cbb87e3ad0f3a03d2 +"infima@npm:0.2.0-alpha.44": + version: 0.2.0-alpha.44 + resolution: "infima@npm:0.2.0-alpha.44" + checksum: 10/a4d724ca23a67229ce61b6f73a4a394ff93a15bd9f141b2941e6dfc032f112ee49362c10ece388c189e53895cd5a8e264671184e097cc48aab90cd7d0fe41646 languageName: node linkType: hard @@ -13789,6 +14081,13 @@ __metadata: languageName: node linkType: hard +"npm-to-yarn@npm:^2.2.1": + version: 2.2.1 + resolution: "npm-to-yarn@npm:2.2.1" + checksum: 10/d3509a61389482e225808b7a9f73ab66d107e53c39d07ab9d5c09139b737185ce91d80e0090d21a9939593a1e729efdd9059ccf52edffda1837805ffea05e2b3 + languageName: node + linkType: hard + "nprogress@npm:^0.2.0": version: 0.2.0 resolution: "nprogress@npm:0.2.0" From c85bdf7852721a21ce299b7c73a1ab25b4618847 Mon Sep 17 00:00:00 2001 From: "shunquan.wang" Date: Sat, 14 Sep 2024 15:14:37 +0800 Subject: [PATCH 2/2] fix: update docs --- website/docusaurus.config.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 3500546..69a7545 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -157,7 +157,6 @@ const config: Config = { return { name: 'docusaurus-tailwindcss', configurePostCss(postcssOptions) { - console.log(postcssOptions); // Appends TailwindCSS and AutoPrefixer. postcssOptions.plugins.push(require.resolve('tailwindcss')); postcssOptions.plugins.push(require.resolve('autoprefixer'));