Skip to content

Commit e2a7931

Browse files
committed
feat: add product docs for share links
1 parent 41e2dc7 commit e2a7931

File tree

7 files changed

+101
-0
lines changed

7 files changed

+101
-0
lines changed

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"product/theming",
4141
"product/files",
4242
"product/responsive-design",
43+
"product/sharing",
4344
{
4445
"group": "Panels",
4546
"icon": "sliders",

images/sharing/draft-share.mp4

651 KB
Binary file not shown.

images/sharing/exit-preview.png

4.98 MB
Loading

images/sharing/past-publish-share.mp4

339 KB
Binary file not shown.

images/sharing/public-preview.png

406 KB
Loading
337 KB
Binary file not shown.

product/sharing.mdx

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: "Sharing"
3+
description: "Makeswift allows you to share previews of different versions of your site for collaboration and feedback."
4+
icon: "share" iconType: "solid"
5+
---
6+
7+
<Warning>
8+
Sharing requires a [custom host](/product/site/hosting#custom-host) running at least `v0.25.0` of the runtime. To upgrade, see our [runtime upgrade guide](/developer/upgrading/0.25.0).
9+
</Warning>
10+
11+
Makeswift allows you to share different versions of your site for enhanced collaboration and feedback. In the Visual Builder, you can create shareable links to different site versions, which you can then send to your team members or stakeholders.
12+
13+
Anyone with these links can view the shared version of your site directly on your site's domain itself. This means that site previews can be viewed on any device, including phones and tablets.
14+
15+
You can generate shareable links for any of the following:
16+
17+
- The current draft state of your site in the Visual Builder
18+
- A particular scheduled publish
19+
- A specific previous publish of your site
20+
21+
## Privacy
22+
23+
Shareable links are site-wide previews. This means that a recipient of a share link will be able to view the entire site as it was in the shared version.
24+
25+
All share links expire after 5 days. After expiration, visiting the share link will result in an error, and users will no longer be able to see the shared version of the site.
26+
27+
By default, share links can only be accessed by other members of your Makeswift workspace. To create a public share link, see the [Public Share Links](#public-share-links) section.
28+
29+
## Sharing Draft State
30+
31+
To share the draft state (the current state of your site in the Visual Builder), click on the "Share" button in the top right corner of the Visual Builder header.
32+
This will open a dialog that has a new shareable link generated for you. You can copy this link and share it with others.
33+
34+
<Frame>
35+
<video
36+
autoPlay
37+
muted
38+
loop
39+
playsInline
40+
controls
41+
title="Sharing draft state"
42+
className="w-full aspect-video"
43+
src="/images/sharing/draft-share.mp4"
44+
></video>
45+
</Frame>
46+
47+
## Sharing a Scheduled Publish
48+
49+
To share a particular scheduled publish, open the publish dialog and navigate to the "Scheduled" tab. Hover over the scheduled publish you'd like to share and click the "Share" icon, which will open a dialog with a shareable link for that specific publish.
50+
51+
<Frame>
52+
<video
53+
autoPlay
54+
muted
55+
loop
56+
playsInline
57+
controls
58+
title="Sharing a scheduled publish"
59+
className="w-full aspect-video"
60+
src="/images/sharing/scheduled-publish-share.mp4"
61+
></video>
62+
</Frame>
63+
64+
65+
## Sharing a Previous Publish
66+
67+
To share a specific previous publish, open the publish dialog and navigate to the "History" tab. Hover over the publish you'd like to share and click the "Share" icon, which will open a dialog with a shareable link for that specific publish.
68+
69+
<Frame>
70+
<video
71+
autoPlay
72+
muted
73+
loop
74+
playsInline
75+
controls
76+
title="Sharing a past publish"
77+
className="w-full aspect-video"
78+
src="/images/sharing/past-publish-share.mp4"
79+
></video>
80+
</Frame>
81+
82+
## Public Share Links
83+
84+
By default, a share link can only be accessed by other members of your Makeswift workspace. This means that in addition to sending the share link, you may also have to invite the recipient as a guest to your workspace.
85+
86+
If you want your share link to be accessible by anyone, you can toggle the "Public preview" option when creating the share link. This will allow anyone with the link to view the shared version of your site without needing to be a member of your Makeswift workspace.
87+
88+
<Frame>
89+
![Public preview toggle](/images/sharing/public-preview.png)
90+
</Frame>
91+
92+
## Exiting the Preview
93+
94+
When you visit a share link, you will see the shared version of the site directly on the site's domain, even after you refresh. To exit the preview and go back to viewing the live site, click the "Exit preview" button in the bottom right corner of the page.
95+
96+
<Frame>
97+
![Exit preview button](/images/sharing/exit-preview.png)
98+
</Frame>
99+
100+
Alternatively, you can also clear your cookies for the site.

0 commit comments

Comments
 (0)