Module: Markdown::Merge::Cleanse

Defined in:

lib/markdown/merge/cleanse.rb,
lib/markdown/merge/cleanse/block_spacing.rb,
lib/markdown/merge/cleanse/code_fence_spacing.rb,
lib/markdown/merge/cleanse/condensed_link_refs.rb

Overview

Namespace for document cleansing/repair utilities.

The Cleanse module contains parsers and fixers for repairing malformed
Markdown documents, particularly those affected by previous bugs in
ast-merge or other merge tools.

Examples:

Fix condensed link reference definitions

content = File.read("README.md")
parser = Markdown::Merge::Cleanse::CondensedLinkRefs.new(content)
if parser.condensed?
  File.write("README.md", parser.expand)
end

Fix code fence spacing issues

content = File.read("README.md")
parser = Markdown::Merge::Cleanse::CodeFenceSpacing.new(content)
if parser.malformed?
  File.write("README.md", parser.fix)
end

Fix block element spacing issues

content = File.read("README.md")
parser = Markdown::Merge::Cleanse::BlockSpacing.new(content)
if parser.malformed?
  File.write("README.md", parser.fix)
end

See Also:

• For fixing condensed link reference definitions
• For fixing code fence spacing issues
• For fixing missing blank lines between block elements

Defined Under Namespace

Classes: BlockSpacing, CodeFenceSpacing, CondensedLinkRefs