☯️ Kramdown::Merge
if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know on Discord or RubyForum, as I may have missed the notification.
if ci_badges.map(&:color).all? { it == "green"} 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️
I've summarized my thoughts in this blog post.
🌻 Synopsis 
Kramdown::Merge is a Ruby provider package for the Markdown merge family. Markdown provider backed by Kramdown. It registers its backend with tree_haver and exposes provider-specific defaults while preserving the canonical family contract.
Key Features
- Backend registration for
Kramdown. - Provider-specific parser capability reporting.
- Family-compatible parse and merge methods.
- Structured diagnostics for unsupported backends and parser failures.
- A provider
SmartMergerwrapper when the underlying family exposes one.
💡 Info you can shake a stick at
| Tokens to Remember |   |
|---|---|
| Works with MRI Ruby 4 |  |
| Support & Community |      |
| Source |     |
| Documentation |      |
| Compliance |      |
| Style |     |
| Maintainer 🎖️ |      |
... 💖 |
    🧊 🐙 🛖 🧪 |
Compatibility
Compatible with MRI Ruby 4.0.0+, and concordant releases of JRuby, and TruffleRuby.
CI workflows and Appraisals are generated for MRI Ruby 4.0.0+.
This test floor is configured by ruby.test_minimum in .kettle-jem.yml and
may be higher than the gem's runtime compatibility floor when legacy Rubies are
not practical for the current toolchain.
The amazing test matrix is powered by the kettle-dev stack.
How kettle-dev manages complexity in tests
| Gem | Source | Role | Total downloads |
|---|---|---|---|
| appraisal2 | GitHub | multi-dependency Appraisal matrix generation |  |
| appraisal2-rubocop | GitHub | RuboCop Appraisal generator integration |  |
| kettle-dev | GitHub | development, release, and CI workflow tooling |  |
| kettle-jem | GitHub | Appraisals & CI workflow templates |  |
| kettle-soup-cover | GitHub | SimpleCov coverage policy and reporting |  |
| kettle-test | GitHub | standard test runner and coverage harness |  |
| rubocop-lts | GitHub | Ruby-version-aware linting |  |
| turbo_tests2 | GitHub | parallel test execution |  |
✨ Installation
Install the gem and add to the application's Gemfile by executing:
bundle add kramdown-merge
If bundler is not being used to manage dependencies, install the gem by executing:
gem install kramdown-merge
⚙️ Configuration
require "kramdown/merge"
profile = Kramdown::Merge.markdown_backend_feature_profile(backend: :kramdown)
context = Kramdown::Merge.markdown_plan_context(backend: :kramdown)
Use this package when you want a hard dependency on the Kramdown backend. Use the canonical family package when backend auto-selection is preferred.
🔧 Basic Usage
require "kramdown/merge"
result = Kramdown::Merge.merge_markdown(
File.read("template.md"),
File.read("destination.md"),
"markdown",
backend: :kramdown,
)
abort result.fetch(:diagnostics).inspect unless result.fetch(:ok)
File.write("destination.md", result.fetch(:output))
🔐 Security
See SECURITY.md.
🤝 Contributing
If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check issues or PRs, or use the gem and think about how it could be better.
We so if you make changes, remember to update it.
See CONTRIBUTING.md for more detailed instructions.
Code Coverage
Coverage service badges
📌 Versioning
This library follows for its public API where practical.
For most applications, prefer the Pessimistic Version Constraint with two digits of precision.
For example:
spec.add_dependency("kramdown-merge", "~> 7.0")
📌 Is "Platform Support" part of the public API? More details inside.
Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:
See CHANGELOG.md for a list of releases.
📄 License
The gem is available under the following licenses: AGPL-3.0-only, PolyForm-Small-Business-1.0.0. See LICENSE.md for details.
If none of the available licenses suit your use case, please contact us to discuss a custom commercial license.