asciidoc_converter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ad369949fcd5b204cbd6cf26ae2b77dded9d7799de30f9e8b84eddebea56c86
+  data.tar.gz: 7d3c785146ce5e5fbfd4fab37944796da4a25f04c90b918dce1ffb05e0a11f94
+SHA512:
+  metadata.gz: d585aee80e38c22d4626d9475f5497c850635867812c814c2c4628e545cf83cfca0c15d71a86d2f65e4838f80ad0b060656a5381df05b04a51bd18fcfce65890
+  data.tar.gz: bf65b1eae1238307cd1c95a96a62c1ed7cbd4abaaad8a2548fd87bf031ce55aeb4775d95fcd4b1f0dfc7a9d4d0126289ba3d35ea9b42e8d1fe91bb791ed58072

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.3
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+
+    - script/**/*
+    - test/fixtures/**/*
+    - vendor/**/*

data/CHANGELOG.adoc

@@ -0,0 +1,14 @@
+= Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog],
+and this project adheres to https://semver.org/spec/v2.0.0.html[Semantic Versioning].
+
+== [Unreleased]
+
+- ...
+
+== [1.0.0] - 2026-07-18
+
+- First version

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "asciidoctor", "~> 2.0"
+gem "bridgetown", "~> 2.2"

data/Gemfile.lock

@@ -0,0 +1,160 @@
+PATH
+  remote: .
+  specs:
+    asciidoc_converter (1.0.0)
+      asciidoctor (>= 2.0)
+      bridgetown (>= 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    amazing_print (1.8.1)
+    asciidoctor (2.0.26)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    bridgetown (2.2.2)
+      bridgetown-builder (= 2.2.2)
+      bridgetown-core (= 2.2.2)
+      bridgetown-foundation (= 2.2.2)
+      bridgetown-paginate (= 2.2.2)
+    bridgetown-builder (2.2.2)
+      bridgetown-core (= 2.2.2)
+    bridgetown-core (2.2.2)
+      addressable (~> 2.4)
+      amazing_print (~> 1.2)
+      base64 (>= 0.3)
+      bigdecimal (>= 3.2)
+      bridgetown-foundation (= 2.2.2)
+      csv (~> 3.2)
+      erubi (~> 1.9)
+      faraday (~> 2.0)
+      faraday-follow_redirects (~> 0.5)
+      freyia (>= 0.5)
+      i18n (~> 1.0)
+      irb (>= 1.14)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (>= 5.0, < 5.5)
+      listen (~> 3.0)
+      rack (>= 3.0)
+      rackup (~> 2.0)
+      rake (>= 13.0)
+      roda (~> 3.46)
+      rouge (>= 3.0, < 5.0)
+      samovar (= 2.4.1)
+      securerandom (~> 0.4)
+      serbea (>= 2.4.1)
+      signalize (~> 1.3)
+      streamlined (>= 0.6.0)
+      tilt (~> 2.0)
+      zeitwerk (>= 2.7.3)
+    bridgetown-foundation (2.2.2)
+      dry-inflector (>= 1.0)
+      hash_with_dot_access (~> 2.0)
+      inclusive (~> 1.0)
+      zeitwerk (~> 2.5)
+    bridgetown-paginate (2.2.2)
+      bridgetown-core (= 2.2.2)
+    concurrent-ruby (1.3.7)
+    console (1.37.0)
+      fiber-annotation
+      fiber-local (~> 1.1)
+      json
+    csv (3.3.5)
+    dry-inflector (1.3.1)
+    erb (6.0.5)
+    erubi (1.13.1)
+    faraday (2.14.3)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-follow_redirects (0.5.0)
+      faraday (>= 1, < 3)
+    faraday-net_http (3.4.4)
+      net-http (~> 0.5)
+    ffi (1.17.4-x86_64-linux-gnu)
+    fiber-annotation (0.2.0)
+    fiber-local (1.1.0)
+      fiber-storage
+    fiber-storage (1.0.1)
+    freyia (0.6.2)
+    hash_with_dot_access (2.2.0)
+    i18n (1.15.2)
+      concurrent-ruby (~> 1.0)
+    inclusive (1.1.0)
+    io-console (0.8.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.21.1)
+    kramdown (2.5.2)
+      rexml (>= 3.4.4)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (5.4.0)
+    listen (3.10.0)
+      logger
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    mapping (1.1.3)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    pp (0.6.4)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    public_suffix (7.0.5)
+    rack (3.2.6)
+    rackup (2.3.1)
+      rack (>= 3)
+    rake (13.4.2)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (4.0.3)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    roda (3.106.0)
+      rack
+    rouge (4.7.0)
+    samovar (2.4.1)
+      console (~> 1.0)
+      mapping (~> 1.0)
+    securerandom (0.4.1)
+    serbea (2.4.1)
+      erubi (>= 1.13)
+      tilt (>= 2.6)
+    signalize (1.3.1)
+      concurrent-ruby (~> 1.2)
+    streamlined (0.6.2)
+      serbea (>= 2.1)
+      zeitwerk (~> 2.5)
+    tilt (2.8.0)
+    tsort (0.2.0)
+    uri (1.1.1)
+    zeitwerk (2.8.2)
+
+PLATFORMS
+  x86_64-linux-gnu
+
+DEPENDENCIES
+  asciidoc_converter!
+  asciidoctor (~> 2.0)
+  bridgetown (~> 2.2)
+
+BUNDLED WITH
+  4.0.16

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2025-present
+
+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.adoc

@@ -0,0 +1,67 @@
+= Sample plugin for Bridgetown
+
+_NOTE: This isn't a real plugin! Copy this sample code and use it to create your own Ruby gem! https://www.bridgetownrb.com/docs/plugins[Help guide here…]_ 😃
+
+_You can run_ `bridgetown plugins new` _to easily set up a customized version of this starter repo._
+
+A Bridgetown plugin to [fill in the blank]…
+
+== Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+bundle add asciidoc_converter
+```
+
+Then add the initializer to your configuration in `config/initializers.rb`:
+
+```ruby
+init :asciidoc_converter
+```
+
+Or if there's a `bridgetown.automation.rb` automation script, you can run that instead for guided setup:
+
+```shell
+bin/bridgetown apply https://github.com/SarahRogue81/asciidoc_converter
+```
+
+== Usage
+
+The plugin will…
+
+=== Optional configuration options
+
+The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
+
+…
+
+== Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and Minitest together.
+
+== Contributing
+
+1. Fork it (https://github.com/SarahRogue/asciidoc_converter/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 https://rubygems.org[RubyGems.org] and https://www.npmjs.com[NPM] 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 https://www.bridgetownrb.com/docs/community[Bridgetown community resources]
+where friendly folks are standing by to help you build and release your plugin or theme.
+
+*NOTE:* make sure you add the `bridgetown-plugin` https://github.com/topics/bridgetown-plugin[topic] to your
+plugin's GitHub repo so the plugin or theme will show up on https://www.bridgetownrb.com/plugins[Bridgetown's official Plugin Directory]! (There may be a day or so delay before you see it appear.)

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/asciidoc_converter.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/asciidoc_converter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciidoc_converter"
+  spec.version       = AsciiDocConverter::VERSION
+  spec.author        = "Sarah Rogue"
+  spec.email         = "emo-girl@sarah-rogue.me"
+  spec.summary       = "AsciiDoc Front Matter reader and Converter for Bridgetown"
+  spec.description   = "Integrates advanced AsciiDoc processing into Bridgetown projects."
+  spec.homepage      = "https://github.com/SarahRogue81/asciidoc_converter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+  # Uncomment this if you wish to supply a companion NPM package and/or command features:
+  # spec.metadata = {
+  #   "npm_add" => "asciidoc_converter@#{AsciiDocConverter::VERSION}",
+  #   "bridgetown_features" => "true"
+  # }
+
+  spec.required_ruby_version = ">= 3.3"
+
+  spec.add_dependency "asciidoctor", ">= 2.0"
+  spec.add_dependency "bridgetown", ">= 2.2"
+end

data/bridgetown.automation.rb

@@ -0,0 +1,57 @@
+# If your plugin requires a lot of steps to get set up, consider writing an automation to help guide users.
+# You could set up and configure all sorts of things, for example:
+#
+# add_gem "my_plugin"
+#
+# add_npm_for_gem "my_plugin"
+#
+# run "bundle add some_other_gem"
+#
+# apply "#{__dir__}/additional.automation.rb"
+#
+# add_initializer :my_plugin do
+#   <<~RUBY
+#     do
+#       some_config_key 12345
+#     end
+#   RUBY
+# end
+#
+# create_builder "my_nifty_builder.rb" do
+#   <<~RUBY
+#     class MyNeatBuilder < SiteBuilder
+#       def build
+#         puts MyPlugin.hello
+#       end
+#     end
+#   RUBY
+# end
+#
+# javascript_import do
+#   <<~JS
+#     import { MyPlugin } from "my_plugin"
+#   JS
+# end
+#
+# javascript_import 'import "my_plugin/frontend/styles/index.css"'
+#
+# create_file "src/_data/plugin_data.yml" do
+#   <<~YAML
+#     data:
+#       goes: here
+#   YAML
+# end
+#
+# color = ask("What's your favorite color?")
+#
+# ruby_configure :favorite_color do
+#   <<~RUBY
+#     favorite_color "#{color}"
+#   YAML
+# end
+#
+# To learn more, read the Automations documentation:
+# * https://www.bridgetownrb.com/docs/automations
+# and the API-level documentation:
+# * Freyia Automations: https://www.rubydoc.info/gems/freyia/Freyia/Automations
+# * Bridgetown Automations: https://api.bridgetownrb.com/Bridgetown/Commands/Actions.html

data/lib/asciidoc_converter/asciidoc.rb

@@ -0,0 +1,35 @@
+require "asciidoctor"
+
+module AsciiDocConverter
+  class AsciiDoc < Bridgetown::Converter
+    # Set priority so it handles files before the Identity converter catches them
+    priority :high
+
+    # Tell Bridgetown to process these source extensions
+    def matches(ext, _convertible = nil)
+      ext =~ /^\.(adoc|asciidoc)$/i
+    end
+
+    # Output everything into static HTML files
+    def output_ext(ext)
+      ".html"
+    end
+
+    # The conversion pipeline handoff
+    def convert(content, convertible = nil)
+      # Setup modern rendering options matching your workspace style
+      options = {
+        safe: :safe,
+        attributes: {
+          "icons" => "font",
+          "sectanchors" => true,
+          "source-highlighter" => "rouge", # Integrates with Bridgetown's default highlighters
+          "imagesdir" => "/images@" # trailing @ makes this a soft default, overridable by an in-document :imagesdir:
+        }
+      }
+
+      # Render the AsciiDoc content string to safe HTML5
+      Asciidoctor.convert(content, options)
+    end
+  end
+end

data/lib/asciidoc_converter/version.rb

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

data/lib/asciidoc_converter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "asciidoc_converter/asciidoc"
+require "asciidoc_front_matter_loader"
+
+# @param config [Bridgetown::Configuration::ConfigurationDSL]
+Bridgetown.initializer :asciidoc_converter do |config|
+  # Add code here which will run when a site includes
+  # `init :asciidoc_converter`
+  # in its configuration
+
+  # Add default configuration data:
+  # config.asciidoc_converter ||= {}
+  # config.asciidoc_converter.my_setting ||= 123
+
+  # Register your builder:
+  # config.builder AsciiDocConverter::Builder
+  config.converter AsciiDocConverter::AsciiDoc
+
+  # You can optionally supply a source manifest:
+  # config.source_manifest(
+  #   origin: AsciiDocConverter,
+  #   components: File.expand_path("../components", __dir__),
+  #   layouts: File.expand_path("../layouts", __dir__),
+  #   content: File.expand_path("../content", __dir__)
+  # )
+
+  AsciiDocFrontMatterLoader.register!
+end

data/lib/asciidoc_front_matter_loader.rb

@@ -0,0 +1,50 @@
+require "asciidoctor"
+
+class AsciiDocFrontMatterLoader < Bridgetown::FrontMatter::Loaders::Base
+  def self.register!
+    Bridgetown::FrontMatter::Loaders.register(self)
+  end
+
+  # Tell Bridgetown to intercept .adoc and .asciidoc files before standard parsing
+  def self.header?(file)
+    File.extname(file) =~ /^\.(adoc|asciidoc)$/i
+  end
+
+  def read(file_contents, file_path: "")
+    return nil unless self.class.header?(file_path)
+
+    # Use Asciidoctor to parse only the header for performance
+    doc = Asciidoctor.load(file_contents, parse_header_only: true)
+    
+    # Map native AsciiDoc attributes into Bridgetown's data structure
+    front_matter = {
+      "title"                      => doc.doctitle,
+      "description"                => doc.attributes["description"],
+      "image"                      => doc.attributes["image"],
+      "author"                     => doc.attributes["author"],
+      "lang"                       => doc.attributes["lang"],
+      "categories"                 => doc.attributes["categories"],
+      "category"                   => doc.attributes["category"],
+      "date"                       => doc.attributes["date"],
+      "id"                         => doc.attributes["id"],
+      "layout"                     => doc.attributes["layout"] || "post",
+      "paginate"                   => doc.attributes["paginate"],
+      "permalink"                  => doc.attributes["permalink"],
+      "published"                  => doc.attributes["published"],
+      "sitemap_change_frequency"   => doc.attributes["sitemap_change_frequency"],
+      "sitemap_priority"           => doc.attributes["sitemap_priority"],
+      "slug"                       => doc.attributes["slug"],
+      "tag"                        => doc.attributes["tag"],
+      "tags"                       => doc.attributes["tags"],
+      "template_engine"            => doc.attributes["template_engine"],
+      "willamette"                 => doc.attributes["willamette"],
+      "willamette.article_classes" => doc.attributes["willamette.article_classes"]
+    }.compact
+
+    Bridgetown::FrontMatter::Loaders::Result.new(
+      content: file_contents,
+      front_matter: front_matter,
+      line_count: file_contents.lines.size
+    )
+  end
+end

data/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "asciidoc_converter",
+  "version": "1.0.0",
+  "main": "frontend/javascript/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SarahRogue81/asciidoc_converter.git"
+  },
+  "author": "Sarah Rogue <emo-girl@sarah-rogue.me>",
+  "homepage": "https://sarah-rogue.me",
+  "license": "MIT",
+  "private": false,
+  "files": [
+    "frontend"
+  ]
+}

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: asciidoc_converter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sarah Rogue
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Integrates advanced AsciiDoc processing into Bridgetown projects.
+email: emo-girl@sarah-rogue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.adoc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.adoc
+- Rakefile
+- asciidoc_converter.gemspec
+- bridgetown.automation.rb
+- lib/asciidoc_converter.rb
+- lib/asciidoc_converter/asciidoc.rb
+- lib/asciidoc_converter/version.rb
+- lib/asciidoc_front_matter_loader.rb
+- package.json
+homepage: https://github.com/SarahRogue81/asciidoc_converter
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: AsciiDoc Front Matter reader and Converter for Bridgetown
+test_files: []