bridgetown-mdjs 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fe089448e5668972743ad5e0e876895b9041c0111e04d16629bb4e29562bfc8
-  data.tar.gz: 4cf16587c152448a5b7624f2bddbdbfa80013c891f36cf17f08b17dca1daff07
+  metadata.gz: 33d28f3d512888b813bc933ca3c5077e5a0d04a7a4c2a3268dc859ed9bf6802e
+  data.tar.gz: b03ef48dc0183a9b74f635799657bf74a16d4c7e1d19b99338d885b790084a43
 SHA512:
-  metadata.gz: 9d0dc12d8d9462cefc8c32dedf079edce314a0f4cda7efdb9f021c8c646a215ddbcedc71a8c1b50b4d5318a18999b8b9badcf7f689d952f03ce836a5b1f5ae3b
-  data.tar.gz: 44b432ab46d7cda81d0466214e88141cdbf4c881cc94999e2da59198529c4cd04018ab531e72e55734e34829b661282b3724cd6d05d1c56e0a8b875cd223ba52
+  metadata.gz: 96cf42294f391c37bfbe2d37321bbaf44129b164176b7d5954f24695318b702fe24baaa6c30d7d5cfdd14642137a58da572042421de6686a4a450764f082b069
+  data.tar.gz: cff481412f456a94d926d1abcc4f11bb407e51f7710fd817be310ad51cccffa31fb958b1087c69aeab3bcc500349678281a0eef43124326c70402dfd69fdc371

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # main
 
+# 1.0.1 / 2021-04-25
+
+* Mark mdjs script output as html safe.
+
 # 1.0.0 / 2021-04-25
 
 * Initial release of bridgetown-mdjs.

data/README.md

@@ -2,14 +2,18 @@
 
 A [Bridgetown](https://www.bridgetownrb.com) plugin to add Kramdown-based support for [Markdown JavaScript (mdjs)](https://rocket.modern-web.dev/docs/markdown-javascript/overview/).
 
+mdjs is a format which allows you to write executable JavaScript from within Markdown files. The mdjs-compatible parser will extract any fenced code block marked as `js script` and later include the extraction(s) within a `<script type="module">` tag at the bottom of the page layout. This means you can import libraries and web components and define various bits of JS inline with your Markdown content.
 
+(**Note:** While the mdjs support in Rocket includes stories and HTML component previews, in this initial release for Bridgetown we're only supporting the basic JavaScript code extractions.)
+
+_Requires Bridgetown 0.21 or higher._
 
 ## Installation
 
 Run this command to add this plugin to your site's Gemfile:
 
 ```shell
-$ bundle add bridgtown-mdjs -g bridgetown_plugins
+$ bundle add bridgetown-mdjs -g bridgetown_plugins
 ```
 
 Then add either a Liquid tag or Ruby helper to your default layout right below the main content.
@@ -30,7 +34,7 @@ Then add either a Liquid tag or Ruby helper to your default layout right below t
 
 ## Usage
 
-The plugin will perform the necessary extractions via the [kramdown-parser-gfm-extractions](https://github.com/bridgetownrb/kramdown-parser-gfm-extractions) add-on to any Markdown file in your Bridgetown site.
+The plugin will perform the necessary extractions (via the [kramdown-parser-gfm-extractions](https://github.com/bridgetownrb/kramdown-parser-gfm-extractions) add-on) to any Markdown file in your Bridgetown site.
 
 Here's an example Markdown file where you can see mdjs in action:
 

data/lib/bridgetown-mdjs/builder.rb

@@ -25,7 +25,7 @@ module BridgetownMdjs
       end
 
       if jscode.present?
-        return <<~HTML
+        return <<~HTML.html_safe
           <script type="module">
           #{jscode}</script>
         HTML

data/lib/bridgetown-mdjs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownMdjs
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-mdjs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bridgetown Team