Module: YARD::Templates::Helpers::MarkupHelper

Included in:

HtmlHelper

Defined in:

lib/yard/templates/helpers/markup_helper.rb

Overview

Helper methods for loading and managing markup types.

Constant Summary

MARKUP_PROVIDERS =

{
  :markdown => [
    {:lib => :bluecloth, :const => 'BlueCloth'},
    {:lib => :maruku, :const => 'Maruku'},
    {:lib => :"rpeg-markdown", :const => "PEGMarkdown"},
    {:lib => :rdiscount, :const => "RDiscount"}
  ],
  :textile => [
    {:lib => :redcloth, :const => 'RedCloth'}
  ],
  :rdoc => [],
  :text => [],
  :html => []
}

MARKUP_EXTENSIONS =

Returns a list of extensions for various markup types. To register extensions for a type, add them to the array of extensions for the type.

Since:

• 0.6.0

{
  :html => ['htm', 'html', 'shtml'],
  :text => ['txt'],
  :textile => ['textile', 'txtile'],
  :markdown => ['markdown', 'md', 'mdown', 'mkd'],
  :rdoc => ['rdoc']
}

MARKUP_FILE_SHEBANG =

Contains the Regexp object that matches the shebang line of extra files to detect the markup type.

/\A#!(\S+)\s*$/