Add example image and fix typo.

MangoUmbrella · Apr 27, 2023 · 281f1e4 · 281f1e4
1 parent f62c0d6
commit 281f1e4
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 [goldmark-figure](https://github.com/MangoUmbrella/goldmark-figure) is a
 [goldmark](http://github.com/yuin/goldmark)
-extension to parse mardown paragraphs that start with an image into HTML
+extension to parse markdown paragraphs that start with an image into HTML
 `<figure>` elements. One nice thing is it doesn't use any new markdown
 syntaxes.
 
@@ -30,8 +30,11 @@ Render result:
 
 Using dedicated `<figure>` and `<figcaption>` elements makes styling images
 with descriptions much easier.
-[Here](https://mangobaby.app/release-notes/v2023.1) is an example. I hear they
-are also good for SEO.
+[Here](https://mangobaby.app/release-notes/v2023.1) is an example:
+
+![Example of an HTML figure with figcaption.](/assets/example.png)
+
+I hear they are also good for SEO.
 
 # Installation
 

diff --git a/assets/example.png b/assets/example.png