Skip to content

Commit a5c1299

Browse files
committed
add share page
1 parent 1023087 commit a5c1299

File tree

4 files changed

+33
-2
lines changed

4 files changed

+33
-2
lines changed

docs/create-diagram.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
sidebar_position: 2
33
---
44

5-
import ThemedImage from '../src/components/ThemedImage';
6-
import Flex from '../src/components/Flex';
5+
import ThemedImage from '../src/components/ThemedImage';
6+
import Flex from '../src/components/Flex';
77
import FAQ from '../src/components/FAQ';
88

99
# Create a diagram

docs/img/dark/share.png

138 KB
Loading

docs/img/light/share.png

140 KB
Loading

docs/share.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,36 @@
22
sidebar_position: 6
33
---
44

5+
import ThemedImage from '../src/components/ThemedImage';
6+
57
# Sharing a diagram
68

9+
Easily share and receive diagrams with a few clicks.
10+
11+
## How to share
12+
13+
Share a diagram by clicking the `Share` button in the menubar, then copy and distribute the generated link that can be used to get a copy of the diagram.
14+
15+
:::info
16+
17+
Sharing a diagram doesn't start a collaboration session and does not let others edit your instance of the diagram.
18+
19+
:::
20+
21+
<ThemedImage lightImageSrc={require("./img/light/share.png").default} darkImageSrc={require("./img/dark/share.png").default} alt="Share" />
22+
23+
## What happens when you share
24+
25+
When you click `Share` a secret gist gets created with the raw json of the diagram. Then when you load a diagram from a shared link the json gets loaded from the gist.
26+
27+
:::warning
28+
29+
While secret gists are not visible to search engines they are still visible if someone comes accross the url.
30+
31+
:::
32+
33+
To learn more about gists, please, refer to the [GitHub Documentation](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists).
34+
35+
In case you want to delete a gist, you can click the `Unshare` button.
36+
37+
Additionally, the gist does not get synced with your working diagram unless you re-share.

0 commit comments

Comments
 (0)