Skip to content

Commit a3de975

Browse files
committed
Improve the example
1 parent dfb22df commit a3de975

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

.npmignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
example
1+
example
2+
*.gif

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ module.exports = {
4242

4343
This guide will show you how to get up and running with `gatsby-embedder-excalidraw` in the fewest steps possible. It uses `gatsby-plugin-mdx` to take advantage of its awesome default behaviour of automatically creating pages based on MDX files in `src/pages`.
4444

45+
### Install dependencies
46+
4547
First, install `gatsby` and its dependencies:
4648

4749
```bash
@@ -54,6 +56,8 @@ Next, install `gatsby-plugin-mdx` and its dependencies:
5456
npm install gatsby-plugin-mdx @mdx-js/mdx @mdx-js/react
5557
```
5658

59+
### Configure plugins
60+
5761
Add `gatsby-plugin-mdx` to your Gatsby config:
5862

5963
```js
@@ -97,6 +101,14 @@ module.exports = {
97101
};
98102
```
99103

104+
### Create a drawing
105+
106+
Head over to [Excalidraw](https://excalidraw.com) and draw something! Once you're satisfied, you can find a shareable link to your drawing in the export dialog, accesible from the icon in the top left corner of the page.
107+
108+
![link](link.gif)
109+
110+
### Embed your drawing
111+
100112
Create an MDX page at `src/pages/index.mdx` and add a link to an Excalidraw diagram:
101113

102114
```markdown

link.gif

643 KB
Loading

0 commit comments

Comments
 (0)