README.md in jekyll-external-links-0.1.2 vs README.md in jekyll-external-links-0.1.3
- old
+ new
@@ -22,10 +22,22 @@
- a[href*=coverity]
- a[href*=codecov]
marker_html: "<span class='ico-ext'><i class='fas fa-external-link-square-alt'></i></span>"
```
-As you can see, by default the Font Awesome’s `fa-externa-link-square-alt` icon is used,
+As you can see, by default the Font Awesome’s `fa-external-link-square-alt` icon is used,
which implies that you are using Font Awesome.
You can set marker_html to empty string and style links with custom CSS rule
(e.g., `a[rel=external] { border-bottom-style: dashed; }`), though it’s less flexible.
+
+## Example site
+
+An example site is included in this repo.
+Use it to demo the plugin and to test it during development.
+The `/` path leads to Markdown version, the `/asciidoc/` path leads to AsciiDoc version.
+
+1. Clone this repository
+2. Navigate into the example-project directory
+3. Run `bundle`
+4. Run `bundle exec jekyll serve`
+5. Open in your favorite browser the URL shown