marble

marble is a Markdown formatter for Ruby. There are many gems which consume Markdown but this gem allows you to generate it.

This is useful if you need to interact with a service that expects correct Markdown, such as Discord. The generated Markdown follows the original spec with some common extensions (such as fenced code blocks and strikethrough).

Add this line to your application's Gemfile:

gem 'marble_markdown'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install marble_markdown

Upon importing the module

require 'marble'
using Marble

formatting methods will be available in Marble. The most common operations are also added to String as extension methods, if you activate these with using Marble.

You can mix and match syntaxes:

Marble.link('#RubyGems'.escape, 'https://rubygems.org/')
=> "[\\#RubyGems](https://rubygems.org/)"

And of course you can chain methods:

'Marble!'.escape.bold.strikethrough.italic
=> "*~~**Marble\\!**~~*"

And use string interpolation to create more complex strings:

"I am #{'bold'.bold} and I am #{'italic'.italic}!"
=> "I am **bold** and I am *italic*!"

All methods return strings.

Return a string with all Markdown syntax escaped. Always use this for sanitising user input so that your own formatting is not broken.

"Markdown syntax" consists of:

["!", "#", "(", ")", "*", "[", "\\", "]", "_", "`", "|", "~"]

Create bolded Markdown text.

Create a code block. If language is not nil, the code block will be "fenced".

If you want a fenced code block with no syntax highlighting, set language to an empty string.

Create italicised Markdown text.

Create struck-through Markdown text.

Create a block quote.

Create a Markdown link.

Create a Markdown image.

Create an ordered list.

Create an unordered list.

Create a horizontal rule.

Create headers of various levels.

This string with all Markdown syntax escaped.

Embolden this string.

Display this string as code.

Italicise this string.

Strike-out this string.

Create a link using this string as the text.