Skip to content

Commit ba7b660

Browse files
committed
Update readme
1 parent ee75355 commit ba7b660

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Embedding Excalidraw diagrams in Markdown
1+
# gatsby-embedder-excalidraw
22

33
This custom transformer for [`gatsby-remark-embedder`](https://github.com/MichaelDeBoey/gatsby-remark-embedder) allows you to embed Excalidraw diagrams in Markdown content simply by pasting an Excalidraw link in the source.
44

5-
The code for this library is lifted from [this file](https://github.com/excalidraw/excalidraw-blog/blob/master/src/excalidraw-embed/index.js) in the [`excalidraw-blog`](https://github.com/excalidraw/excalidraw-blog) Gatsby site. All credit for this transformer goes to those authors. I was inspired to do this when I saw [Alex Luong's tweet](https://twitter.com/alex__luong/status/1257909443112497153) about making this functionality into a `gatsby-remark-excalidraw` plugin.
5+
The code for this library is lifted from [this file](https://github.com/excalidraw/excalidraw-blog/blob/master/src/gatsby-embedder-excalidraw/index.js) in the [`excalidraw-blog`](https://github.com/excalidraw/excalidraw-blog) Gatsby site. All credit for this transformer goes to those authors. I was inspired to do this when I saw [Alex Luong's tweet](https://twitter.com/alex__luong/status/1257909443112497153) about making this functionality into a `gatsby-remark-excalidraw` plugin.
66

77
- [Installation](#installation)
88
- [Usage](#usage)
@@ -12,7 +12,7 @@ The code for this library is lifted from [this file](https://github.com/excalidr
1212
## Installation
1313

1414
```bash
15-
npm install excalidraw-embed
15+
npm install gatsby-embedder-excalidraw
1616
```
1717

1818
## Usage
@@ -28,7 +28,7 @@ module.exports = {
2828
{
2929
resolve: 'gatsby-remark-embedder',
3030
options: {
31-
customTransformers: [require('excalidraw-embed')]
31+
customTransformers: [require('gatsby-embedder-excalidraw')]
3232
}
3333
}
3434
]
@@ -40,7 +40,7 @@ module.exports = {
4040

4141
## Example
4242

43-
This guide will show you how to get up and running with `excalidraw-embed` 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`.
43+
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

4545
First, install `gatsby` and its dependencies:
4646

@@ -67,13 +67,13 @@ module.exports = {
6767
};
6868
```
6969

70-
Install the `gatsby-remark-embedder` plugin and this Excalidraw transformer `excalidraw-embed`:
70+
Install the `gatsby-remark-embedder` plugin and this Excalidraw transformer `gatsby-embedder-excalidraw`:
7171

7272
```bash
73-
npm install gatsby-remark-embedder excalidraw-embed
73+
npm install gatsby-remark-embedder gatsby-embedder-excalidraw
7474
```
7575

76-
Add `gatsby-remark-embedder` as a Gatsby remark plugin for `gatsby-plugin-mdx`. In your `gatsby-remark-embedder` options, add `excalidraw-embed` as a custom transformer:
76+
Add `gatsby-remark-embedder` as a Gatsby remark plugin for `gatsby-plugin-mdx`. In your `gatsby-remark-embedder` options, add `gatsby-embedder-excalidraw` as a custom transformer:
7777

7878
```diff
7979
// gatsby-config.js
@@ -87,7 +87,7 @@ module.exports = {
8787
+ {
8888
+ resolve: 'gatsby-remark-embedder',
8989
+ options: {
90-
+ customTransformers: [require('excalidraw-embed')]
90+
+ customTransformers: [require('gatsby-embedder-excalidraw')]
9191
+ }
9292
+ }
9393
+ ]

0 commit comments

Comments
 (0)