Skip to content

Commit dd2a9ca

Browse files
committed
chore: added template sharing
1 parent a1549f7 commit dd2a9ca

File tree

1 file changed

+51
-15
lines changed

1 file changed

+51
-15
lines changed

README.md

Lines changed: 51 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ This plugin is licensed under the GPL v2 or later.
99

1010
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](http://www.gnu.org/licenses/gpl-2.0.html)
1111

12-
This tool enables synchronization of block patterns across multiple sites in a WordPress multisite network.
12+
This tool enables synchronization of block patterns and templates across multiple sites in a WordPress multisite network.
1313

1414
## Description
15-
OneDesign allows you to define patterns on a Governing site and apply them to brand sites, maintaining consistency across your network. The plugin provides an intuitive interface for browsing, searching, and applying patterns, making it easy to maintain design consistency across all your network sites.
15+
OneDesign allows you to define patterns and templates on a Governing site and apply them to brand sites, maintaining consistency across your network. The plugin provides an intuitive interface for browsing, searching, and applying patterns and templates, making it easy to maintain design consistency across all your network sites.
1616

1717
## Why OneDesign?
18-
Managing multiple websites—whether for different brands, regions, or languages shouldnt mean reinventing the wheel each time. Instead of designing layouts from scratch for each site, OneDesign lets you create once and deploy anywhere, in just one click.
18+
Managing multiple websites—whether for different brands, regions, or languages shouldn't mean reinventing the wheel each time. Instead of designing layouts from scratch for each site, OneDesign lets you create once and deploy anywhere, in just one click.
1919

2020
Built for enterprise teams, OneDesign unifies your design, editorial, and development processes across all web properties. The result? A shared design system that dramatically cuts down on development, decision-making, and opportunity costs—saving you hundreds of thousands of dollars.
2121

@@ -45,29 +45,33 @@ Built for enterprise teams, OneDesign unifies your design, editorial, and develo
4545

4646
- **Multisite Pattern Sync**: Define patterns on the governing site and apply to multiple brand sites
4747

48+
- **Template Sharing & Sync**: Share complete templates between sites with automatic pattern and template part synchronization
49+
50+
- **Intelligent Template Sync**: Templates automatically resync when updated on the governing site, ensuring brand sites stay current
51+
4852
- **Pattern Management**: View and manage already applied patterns
4953

5054
## Requirements
5155
| Requirement | Version |
5256
|---------------|----------------------------------------------------|
53-
| WordPress | >= 6.2.6 |
54-
| PHP | >= 7.4 |
55-
| Tested Up to | >= 6.8.2 |
56-
| Stable Tag | 1.0 |
57+
| WordPress | >= 6.8 |
58+
| PHP | >= 8.0 |
59+
| Tested Up to | >= 6.9 |
60+
| Stable Tag | 1.1.0-beta.1 |
5761
| Prerequisites | <ul><li>A FSE (Full Site Editing) compatible theme across all sites. With same variables and variations.</li><li>All the blocks used in the patterns must be available on all sites.</li></ul> |
5862

5963
## Installation
6064
1. Download the OneDesign plugin ZIP from Releases of GitHub Repository.
6165
2. Upload the `OneDesign` directory to the `/wp-content/plugins/` directory
62-
3. For multisite installations, network activate the plugin through the Plugins menu in WordPress
63-
4. For single site installations, activate the plugin through the Plugins menu in WordPress
66+
3. For multisite installations, network activate the plugin through the 'Plugins' menu in WordPress
67+
4. For single site installations, activate the plugin through the 'Plugins' menu in WordPress
6468

6569
## How It Works
6670

6771
### Setting Up Governing and Brand Sites
6872
1. Install and activate the OneDesign plugin on all sites in your network
69-
2. From the OneDesign settings, designate one site as the Governing Site (source of patterns)
70-
3. Designate all other sites as Brand Sites (where patterns will be applied)
73+
2. From the OneDesign settings, designate one site as the "Governing Site" (source of patterns)
74+
3. Designate all other sites as "Brand Sites" (where patterns will be applied)
7175
4. Copy the API keys generated for each Brand Site from their respective settings pages
7276
5. In the Governing Site settings, register each Brand Site by adding:
7377
- Site name
@@ -87,14 +91,33 @@ Built for enterprise teams, OneDesign unifies your design, editorial, and develo
8791
- Use the search functionality to find specific patterns
8892
2. **Applying Patterns:**
8993
- Select the patterns you want to sync by clicking on them
90-
- Click Apply to Sites to open the site selection modal
94+
- Click "Apply to Sites" to open the site selection modal
9195
- Choose the destination sites from the modal
92-
- Click Apply Patterns to distribute the selected patterns
96+
- Click "Apply Patterns" to distribute the selected patterns
9397
3. **Removing Patterns:**
94-
- Access the list of applied patterns by selecting the sites tab
98+
- Access the list of applied patterns by selecting the site's tab
9599
- Select the patterns you want to remove
96-
- Click Remove Selected Patterns
100+
- Click "Remove Selected Patterns"
97101
- Confirm the removal, and the patterns will be deleted from that site
102+
103+
### Working with Templates
104+
105+
OneDesign extends beyond patterns to support full template synchronization across your network.
106+
107+
1. **Sharing Templates:**
108+
- Navigate to the Template Library from the OneDesign menu
109+
- Select the templates you want to share with brand sites
110+
- Click "Share Templates" to distribute them across your network
111+
112+
2. **Automatic Pattern & Template Part Creation:**
113+
- When you share a template, all patterns and template parts used within it are automatically created on the brand site
114+
- This ensures complete design consistency without manual pattern-by-pattern synchronization
115+
116+
3. **Template Updates & Re-sync:**
117+
- If you modify a template on the governing site after it's been shared, simply re-sync it
118+
- Go to perticular brand site tab on which you need to re-sync and click "Sync Shared Templates"
119+
- All changes, including updated patterns and template parts, will be pushed to connected brand sites
120+
- Brand sites automatically receive the latest version, maintaining consistency across your network
98121

99122
### Video Demo
100123

@@ -110,15 +133,28 @@ Contributions are **Welcome** and **encouraged!** To learn more about contributi
110133
For development guidelines, please refer to our [Development Guide](./docs/DEVELOPMENT.md).
111134

112135
## Frequently Asked Questions
136+
113137
### How are patterns transferred between sites?
114138
Patterns are transferred securely via WordPress REST API, ensuring that all pattern data, including blocks and settings, are properly synchronized.
139+
115140
### Can I customize which patterns are available to specific sites?
116141
Yes, you can control which patterns are applied to each brand site by managing the selections in the Pattern Library.
142+
117143
### Are there any limits to how many patterns I can sync?
118144
There are no hard limits on the number of patterns you can sync, but performance may vary depending on your server resources and the complexity of the patterns.
145+
119146
### Can I also remove patterns from specific sites?
120147
Yes. You are able to do that from the dashboard itself.
121148

149+
### Can I share complete templates instead of individual patterns?
150+
Yes! OneDesign supports full template sharing. When you share a template, all patterns and template parts within that template are automatically created on the brand site, ensuring complete design consistency.
151+
152+
### What happens when I update a template on the governing site?
153+
You can re-sync templates after making changes on the governing site. Simply select the template and use the sync function to push all updates, including modified patterns and template parts, to all connected brand sites.
154+
155+
### Do I need to manually sync patterns used in templates?
156+
No. When you share a template, OneDesign automatically creates all required patterns and template parts on the brand site. You only need to share the template itself.
157+
122158
### Troubleshooting
123159
1. **Patterns not showing up in the library**
124160
- Ensure your governing site is correctly set up

0 commit comments

Comments
 (0)