@spree/docs 0.1.91 → 0.1.92
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/developer/admin/custom-css.md +1 -0
- package/dist/developer/customization/authentication.md +1 -1
- package/dist/developer/customization/emails.md +1 -0
- package/dist/developer/customization/model-preferences.md +1 -0
- package/dist/developer/deployment/caching.md +1 -1
- package/dist/developer/multi-store/quickstart.md +2 -1
- package/dist/developer/multi-tenant/core-concepts.md +1 -0
- package/dist/developer/multi-tenant/installation.md +1 -1
- package/dist/developer/multi-vendor/installation.md +1 -1
- package/dist/integrations/analytics/google-analytics.md +1 -1
- package/dist/integrations/analytics/google-tag-manager.md +1 -1
- package/dist/integrations/marketing/klaviyo.md +1 -1
- package/dist/integrations/payments/adyen.md +1 -1
- package/dist/integrations/payments/paypal.md +1 -1
- package/dist/integrations/payments/razorpay.md +1 -1
- package/dist/integrations/payments/stripe.md +1 -1
- package/dist/integrations/search/meilisearch.md +1 -1
- package/package.json +1 -1
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Admin Dashboard Custom CSS
|
|
3
3
|
sidebarTitle: Custom CSS
|
|
4
|
+
description: Customize the Spree Admin Dashboard with your own CSS by overriding Tailwind variables, adding custom styles, and extending admin views and helpers.
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
Spree Admin Dashboard uses [Tailwind CSS v4](https://tailwindcss.com/) for styling. The stylesheet system is designed to be easily customizable while maintaining consistency with the Spree design system.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Authentication
|
|
3
|
-
description:
|
|
3
|
+
description: Integrate Spree with a custom authentication setup, including Devise, an existing user model, OmniAuth providers, and JWT or OAuth API tokens.
|
|
4
4
|
version: v5
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Emails
|
|
3
|
+
description: Customize Spree transactional emails using the spree_emails gem and Postmark templates, including how to preview mailers locally during development.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
> **NOTE:** Emails are now part of `spree_emails` gem. If you use `spree_starter` you already have it installed.
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Model Preferences
|
|
3
|
+
description: Add typed configuration options to Spree models using model preferences, including supported types, default values, and reading or writing stored values.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
Model preferences allow you to easily extend Spree models with configuration options. Thanks to this you can store useful information on Spree models, eg.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Caching
|
|
3
|
-
description: Configure caching for your Spree application
|
|
3
|
+
description: Configure Redis-backed caching for your Spree application to speed up database queries and template renders, with tips for cache keys and invalidation.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
Caching improves performance by storing the results of expensive database queries and template renders in memory.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: Multi-Store Spree Commerce
|
|
2
|
+
title: Multi-Store Spree Commerce Quickstart
|
|
3
3
|
sidebarTitle: Quickstart
|
|
4
|
+
description: Enable multiple storefronts on a single Spree app with the spree_multi_store gem, including per-store products, payment methods, taxonomies, and promotions.
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
To enable multiple stores, you will need to add the `spree_multi_store` gem to your project via:
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Multi-Tenant Core Concepts
|
|
3
3
|
sidebarTitle: Core Concepts
|
|
4
|
+
description: Understand the Spree multi-tenant architecture, including the Tenant class, row-level tenant isolation, tenanted models, and automatic seeding for new tenants.
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
## Tenant class
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Spree Multi Tenant Installation
|
|
3
3
|
sidebarTitle: Installation
|
|
4
|
-
description:
|
|
4
|
+
description: Install and configure Spree Multi-Tenant to run a SaaS ecommerce platform, including prerequisites, gem setup, license keys, and tenant provisioning.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
> **WARNING:** This installation instructions assume you have a clean Spree Starter installation and you've purchased the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Spree Multi Vendor Installation
|
|
3
3
|
sidebarTitle: Installation
|
|
4
|
-
description:
|
|
4
|
+
description: Install and configure Spree Multi-Vendor to launch a marketplace with multiple vendors, including prerequisites, gem setup, license keys, and vendor onboarding.
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
> **WARNING:** This installation instructions assume you have purchased the [Spree Enterprise Edition license](https://spreecommerce.org/pricing).
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Connect Google Analytics 4 to Spree Commerce"
|
|
3
3
|
sidebarTitle: Google Analytics 4
|
|
4
|
-
description: "
|
|
4
|
+
description: "Set up Spree's native Google Analytics 4 integration to track ecommerce events, user behavior, and sales performance across your store with no custom code."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Spree Commerce comes with a native Google Analytics 4 integration that allows you to track user behavior, sales performance, and marketing effectiveness across your store.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Connect Google Tag Manager to Spree Commerce"
|
|
3
3
|
sidebarTitle: Google Tag Manager
|
|
4
|
-
description: "
|
|
4
|
+
description: "Connect Spree's native Google Tag Manager integration to push ecommerce dataLayer events for GA4, Google Ads, Meta Pixel, and other marketing tags."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Google Tag Manager is a flexible tag management tool that lets you deploy and manage analytics, SEO, and marketing scripts across your store without editing code. You can connect services like Google Analytics 4, Google Ads, Meta Pixel, Microsoft Clarity, LinkedIn Insights, and Hotjar from one central workspace.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Connect Klaviyo email marketing platform to Spree Commerce"
|
|
3
3
|
sidebarTitle: Klaviyo
|
|
4
|
-
description: "
|
|
4
|
+
description: "Connect Spree to Klaviyo to sync customer profiles, track ecommerce events, and power email and SMS marketing automations, segmentation, and newsletter signups."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Klaviyo is a powerful marketing automation platform used for email and SMS campaigns. By connecting your store to Klaviyo, you can automatically track user interactions, build audience profiles, and grow your newsletter subscriber base - all without manual setup.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Connect Adyen payments to Spree Commerce"
|
|
3
3
|
sidebarTitle: "Adyen"
|
|
4
|
-
description: "
|
|
4
|
+
description: "Set up Spree's native Adyen integration to accept global payments across multiple methods, with built-in fraud protection and a seamless checkout experience."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Adyen is a global payment platform that enables businesses to accept payments across multiple channels and markets. It supports a wide range of payment methods, provides advanced fraud protection, and offers seamless checkout experiences for customers worldwide.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Connect PayPal payments to Spree Commerce"
|
|
3
3
|
sidebarTitle: "PayPal"
|
|
4
|
-
description: "
|
|
4
|
+
description: "Enable Spree's native PayPal integration to accept PayPal, Pay Later (BNPL), Venmo, and guest checkout payments without forcing shoppers to create an account."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
PayPal is a global online payment system that allows your customers to pay using their PayPal balance, linked credit or debit cards, or bank accounts. Spree's native PayPal integration also supports PayPal Pay Later (BNPL), Venmo (US only), and guest checkout — giving shoppers flexibility at the payment step without forcing them to create a PayPal account.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Connect Razorpay payments to Spree Commerce"
|
|
3
3
|
sidebarTitle: Razorpay
|
|
4
|
-
description: "
|
|
4
|
+
description: "Configure the Razorpay payment gateway in Spree to accept cards, UPI, net banking, and wallets, plus international transactions across multiple currencies."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Razorpay is a secure payment gateway that enables businesses to accept online payments via cards, UPI, net banking, and wallets. It also supports international transactions across multiple currencies.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Connect Stripe payments to Spree Commerce"
|
|
3
3
|
sidebarTitle: Stripe
|
|
4
|
-
description: "
|
|
4
|
+
description: "Set up Spree's native Stripe integration to accept cards and alternative payment methods, automate payouts, and power marketplace split payments on Enterprise."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Stripe is a widely used payment processor that enables secure and seamless transactions for online businesses. It supports multiple payment methods, automates payouts, and ensures a smooth checkout experience for customers.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Meilisearch
|
|
3
|
-
description: "Set up Meilisearch for fast, typo-tolerant product search with faceted filtering"
|
|
3
|
+
description: "Set up Meilisearch in Spree for fast, typo-tolerant product search with faceted filtering, relevance ranking, and sub-50ms responses across large catalogs."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
## Overview
|