Question 1

How do I customize the sanitization allowlist in HTML-Pipeline?

Accepted Answer

Modify the DEFAULT_CONFIG hash or pass a custom config to sanitization_config. For example, to allow iframes, deep duplicate the default config and add 'iframe' to the elements array, as shown in the FAQ section.

Question 2

HTML-Pipeline vs CommonMarker for Markdown processing in Ruby?

Accepted Answer

HTML-Pipeline uses CommonMarker under the hood but adds a layer of chainable filters for sanitization and enrichment. Choose HTML-Pipeline for complex pipelines with multiple transformations; use CommonMarker directly for simple Markdown-to-HTML conversion.

Question 3

How to add emoji support to HTML-Pipeline?

Accepted Answer

Use the built-in EmojiFilter in your node filters, but note that the MarkdownFilter already converts emoji. Ensure you have the necessary gem dependencies and require the filter in your pipeline setup.

Question 4

Does HTML-Pipeline work with Rails applications?

Accepted Answer

Yes, it integrates well with Rails, especially using ActiveSupport::Notifications for instrumentation. Add the gem to your Gemfile and require filters in initializers or controllers as needed.

Question 5

How to handle dependencies for syntax highlighting in HTML-Pipeline?

Accepted Answer

You must manually add the 'rouge' gem to your Gemfile and require it, since dependencies are unbundled. Use HTMLPipeline.require_dependency to check availability during development.

Question 6

Is HTML-Pipeline still actively maintained?

Accepted Answer

The project is community-maintained after GitHub stopped using it. Check the GitHub repository for recent commits and issues, as updates may depend on contributor efforts rather than corporate backing.

HTML::Pipeline

What is HTML::Pipeline?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions