bridgetown-mdjs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fe089448e5668972743ad5e0e876895b9041c0111e04d16629bb4e29562bfc8
+  data.tar.gz: 4cf16587c152448a5b7624f2bddbdbfa80013c891f36cf17f08b17dca1daff07
+SHA512:
+  metadata.gz: 9d0dc12d8d9462cefc8c32dedf079edce314a0f4cda7efdb9f021c8c646a215ddbcedc71a8c1b50b4d5318a18999b8b9badcf7f689d952f03ce836a5b1f5ae3b
+  data.tar.gz: 44b432ab46d7cda81d0466214e88141cdbf4c881cc94999e2da59198529c4cd04018ab531e72e55734e34829b661282b3724cd6d05d1c56e0a8b875cd223ba52

data/.gitignore

@@ -0,0 +1,38 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+spec/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# main
+
+# 1.0.0 / 2021-04-25
+
+* Initial release of bridgetown-mdjs.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "rake"
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+group :test do
+  gem "minitest"
+  gem "minitest-reporters"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-present Jared White and Bridgetown contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# bridgetown-mdjs
+
+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/).
+
+
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add bridgtown-mdjs -g bridgetown_plugins
+```
+
+Then add either a Liquid tag or Ruby helper to your default layout right below the main content.
+
+```html
+<!-- Liquid -->
+<main>
+   {{ content }}
+   {% mdjs_script %}
+</main>
+
+<!-- ERB -->
+<main>
+  <%= yield %>
+  <%= mdjs_script %>
+</main>
+```
+
+## 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.
+
+Here's an example Markdown file where you can see mdjs in action:
+
+~~~markdown
+# Introducing mdjs
+
+Let's import some components from Skypack!
+
+```js script
+import SlIcon from "https://cdn.skypack.dev/@shoelace-style/shoelace/dist/components/icon/icon.js"
+import SlIconButton from "https://cdn.skypack.dev/@shoelace-style/shoelace/dist/components/icon-button/icon-button.js"
+import { setBasePath } from "https://cdn.skypack.dev/@shoelace-style/shoelace/dist/utilities/base-path.js"
+
+setBasePath("https://cdn.skypack.dev/@shoelace-style/shoelace/dist")
+```
+
+## Hello from Shoelace!
+
+<sl-icon-button name="emoji-smile" label="Yo!"></sl-icon-button>
+
+And it's easy to change the DOM…
+
+<aside id="hey-hey"></aside>
+
+```js script
+document.querySelector("#hey-hey").innerHTML = "<p>You you!</p>"
+```
+~~~
+
+### Optional configuration options
+
+By default, extraction tags (inert, using `template`) aren't included in the rendered output HTML. You can change those options inside the `kramdown` namespace in `bridgetown.config.yml`. See [kramdown-parser-gfm-extractions](https://github.com/bridgetownrb/kramdown-parser-gfm-extractions) README for further details.
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Run `rubocop` to check for any style offenses.
+
+## Releasing
+
+* Run `bundle exec rake test_and_release` to verify rubocop and tests before releasing a new gem.
+
+## Contributing
+
+1. Fork it (https://github.com/bridgetownrb/bridgetown-mdjs/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+----
+
+## Releasing (you can delete this section in your own plugin repo)
+
+To release a new version of the plugin, simply bump up the version number in both `version.rb` and
+`package.json`, and then run `script/release`. This will require you to have a registered account
+with both the [RubyGems.org](https://rubygems.org) and [NPM](https://www.npmjs.com) registries.
+You can optionally remove the `package.json` and `frontend` folder if you don't need to package frontend
+assets for Webpack.
+
+If you run into any problems or need further guidance, please check out our [Bridgetown community resources](https://www.bridgetownrb.com/docs/community)
+where friendly folks are standing by to help you build and release your plugin or theme.
+
+**NOTE:** make sure you add the `bridgetown-plugin` [topic](https://github.com/topics/bridgetown-plugin) to your
+plugin's GitHub repo so the plugin or theme will show up on [Bridgetown's official Plugin Directory](https://www.bridgetownrb.com/plugins)! (There may be a day or so delay before you see it appear.)

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+RuboCop::RakeTask.new
+
+task :test_and_release => [:rubocop, :test] do |t|
+  # Release the gem if rubocop and tests pass
+  Rake::Task["release"].invoke
+end
+
+task :default => :test

data/bridgetown-mdjs.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-mdjs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-mdjs"
+  spec.version       = BridgetownMdjs::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "Kramdown-based support for Markdown JavaScript (mdjs) in Bridgetown"
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown-mdjs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "bridgetown", ">= 0.21.0.beta1", "< 2.0"
+  spec.add_dependency "kramdown-parser-gfm-extractions", "~> 1.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/lib/bridgetown-mdjs.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown-mdjs/builder"

data/lib/bridgetown-mdjs/builder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module BridgetownMdjs
+  class Builder < Bridgetown::Builder
+    def build
+      # Set the kramdown input to use the extractions parser
+      site.config.kramdown.input = "GFMExtractions"
+
+      # Obtain method as a proc and call it from within either the Liquid or Ruby helper contexts
+      method(:process_extractions).tap do |process_the|
+        liquid_tag "mdjs_script" do |_attributes, tag|
+          process_the.(tag.context.registers[:page][:markdown_extractions])
+        end
+        helper "mdjs_script", helpers_scope: true do
+          process_the.(view.page.data.markdown_extractions)
+        end
+      end
+    end
+
+    def process_extractions(extractions)
+      jscode = +""
+
+      extractions&.each do |extraction|
+        jscode << extraction.code if (extraction.lang == "js") && (extraction.meta == "script")
+      end
+
+      if jscode.present?
+        return <<~HTML
+          <script type="module">
+          #{jscode}</script>
+        HTML
+      end
+
+      jscode
+    end
+  end
+end
+
+BridgetownMdjs::Builder.register

data/lib/bridgetown-mdjs/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-mdjs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm-extractions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-mdjs.gemspec
+- lib/bridgetown-mdjs.rb
+- lib/bridgetown-mdjs/builder.rb
+- lib/bridgetown-mdjs/version.rb
+homepage: https://github.com/bridgetownrb/bridgetown-mdjs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Kramdown-based support for Markdown JavaScript (mdjs) in Bridgetown
+test_files: []