class

Markd::Options

Inherits Reference < Object

Markdown rendering options.

Constructors

new(time : Bool = false, gfm : Bool = false, toc : Bool = false, smart : Bool = false, source_pos : Bool = false, safe : Bool = false, prettyprint : Bool = false, emoji : Bool = false, tagfilter : Bool = false, autolink : Bool = false, base_url : Nil | URI = nil)
Source

Instance methods

autolink=(autolink : Bool)

If true, more autolinks will be detected. Setting to false does not disable autolink support as a whole.

Source
autolink?

If true, more autolinks will be detected. Setting to false does not disable autolink support as a whole.

Source
base_url

If base_url is not nil, it is used to resolve URLs of relative links. It act's like HTML's <base href="base_url"> in the context of a Markdown document.

Source
base_url=(base_url : URI | Nil)

If base_url is not nil, it is used to resolve URLs of relative links. It act's like HTML's <base href="base_url"> in the context of a Markdown document.

Source
emoji=(emoji : Bool)

Enables GFM emoji support.

For example:

@octocat :+1: This PR looks great - it's ready to merge! :ship:

Becomes:

@octocat 👍 This PR looks great - it's ready to merge! 🚢

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#using-emojis

Source
emoji?

Enables GFM emoji support.

For example:

@octocat :+1: This PR looks great - it's ready to merge! :ship:

Becomes:

@octocat 👍 This PR looks great - it's ready to merge! 🚢

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#using-emojis

Source
gfm

DEPRECATED Use #gfm? instead.

Source
gfm=(gfm : Bool)

Enables GitHub Flavored Markdown support.

https://github.github.com/gfm/

Source
gfm?

Enables GitHub Flavored Markdown support.

https://github.github.com/gfm/

Source
prettyprint

DEPRECATED Use #prettyprint? instead.

Source
prettyprint=(prettyprint : Bool)

If true, code tags generated by code blocks will have a prettyprint class added to them, to be used by Google code-prettify.

Source
prettyprint?

If true, code tags generated by code blocks will have a prettyprint class added to them, to be used by Google code-prettify.

Source
safe

DEPRECATED Use #safe? instead.

Source
safe=(safe : Bool)

If true, raw HTML will not be passed through to HTML output (it will be replaced by comments).

Source
safe?

If true, raw HTML will not be passed through to HTML output (it will be replaced by comments).

Source
smart

DEPRECATED Use #smart? instead.

Source
smart=(smart : Bool)

If true:

  • straight quotes will be made curly
  • -- will be changed to an en dash
  • --- will be changed to an em dash
  • ... will be changed to ellipses
Source
smart?

If true:

  • straight quotes will be made curly
  • -- will be changed to an en dash
  • --- will be changed to an em dash
  • ... will be changed to ellipses
Source
source_pos

DEPRECATED Use #source_pos? instead.

Source
source_pos=(source_pos : Bool)

If true, source position information for block-level elements will be rendered in the data-sourcepos attribute (for HTML).

Source
source_pos?

If true, source position information for block-level elements will be rendered in the data-sourcepos attribute (for HTML).

Source
tagfilter=(tagfilter : Bool)

If true, the following HTML tags will be filtered when rendering HTML output:

  • <title>
  • <textarea>
  • <style>
  • <xmp>
  • <iframe>
  • <noembed>
  • <noframes>
  • <script>
  • <plaintext>

All other HTML tags are left untouched.

Source
tagfilter?

If true, the following HTML tags will be filtered when rendering HTML output:

  • <title>
  • <textarea>
  • <style>
  • <xmp>
  • <iframe>
  • <noembed>
  • <noframes>
  • <script>
  • <plaintext>

All other HTML tags are left untouched.

Source
time

DEPRECATED Use #time? instead.

Source
time=(time : Bool)

Render parsing cost time for reading the source, parsing blocks, and parsing inline.

Source
time?

Render parsing cost time for reading the source, parsing blocks, and parsing inline.

Source
toc=(toc : Bool)

Not supported for now.

Source
toc?

Not supported for now.

Source