Class: RDoc::Markup::ToMarkdown (Ruby 2.7.3)
Description: Class : RDoc::Markup::ToMarkdown - Ruby 2.7.3

### Home Classes Methods

### In Files

- rdoc/markup/to_markdown.rb

### Parent

RDoc::Markup::ToRdoc

### Methods

- ::new
- #accept_list_end
- #accept_list_item_end
- #accept_list_item_start
- #accept_list_start
- #accept_rule
- #accept_verbatim
- #gen_url
- #handle_rdoc_link
- #handle_regexp_HARD_BREAK
- #handle_regexp_RDOCLINK
- #handle_regexp_TIDYLINK
- #init_tags

### Class/Module Index

Quicksearch

- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Comment
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::CrossReference
- RDoc::ERBIO
- RDoc::ERBPartial
- RDoc::Encoding
- RDoc::Error
- RDoc::Extend
- RDoc::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::POT
- RDoc::Generator::POT::MessageExtractor
- RDoc::Generator::POT::PO
- RDoc::Generator::POT::POEntry
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::I18n
- RDoc::I18n::Locale
- RDoc::I18n::Text
- RDoc::Include
- RDoc::Markdown
- RDoc::Markdown::Literals
- RDoc::Markup
- RDoc::Markup::AttrChanger
- RDoc::Markup::AttrSpan
- RDoc::Markup::AttributeManager
- RDoc::Markup::Attributes
- RDoc::Markup::BlankLine
- RDoc::Markup::BlockQuote
- RDoc::Markup::Document
- RDoc::Markup::Formatter
- RDoc::Markup::HardBreak
- RDoc::Markup::Include
- RDoc::Markup::IndentedParagraph
- RDoc::Markup::List
- RDoc::Markup::ListItem
- RDoc::Markup::Paragraph
- RDoc::Markup::Parser
- RDoc::Markup::Parser::Error
- RDoc::Markup::Parser::MyStringScanner
- RDoc::Markup::Parser::ParseError
- RDoc::Markup::PreProcess
- RDoc::Markup::Raw
- RDoc::Markup::RegexpHandling
- RDoc::Markup::Rule
- RDoc::Markup::ToAnsi
- RDoc::Markup::ToBs
- RDoc::Markup::ToHtml
- RDoc::Markup::ToHtmlCrossref
- RDoc::Markup::ToHtmlSnippet
- RDoc::Markup::ToJoinedParagraph
- RDoc::Markup::ToLabel
- RDoc::Markup::ToMarkdown
- RDoc::Markup::ToRdoc
- RDoc::Markup::ToTableOfContents
- RDoc::Markup::ToTest
- RDoc::Markup::ToTtOnly
- RDoc::Markup::Verbatim
- RDoc::MetaMethod
- RDoc::MethodAttr
- RDoc::Mixin
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::Parser::ChangeLog
- RDoc::Parser::Markdown
- RDoc::Parser::RD
- RDoc::Parser::RipperStateLex
- RDoc::Parser::RipperStateLex::InnerStateLex
- RDoc::Parser::Ruby
- RDoc::Parser::RubyTools
- RDoc::Parser::Simple
- RDoc::Parser::Text
- RDoc::RD
- RDoc::RD::BlockParser
- RDoc::RD::Inline
- RDoc::RD::InlineParser
- RDoc::RDoc
- RDoc::RI
- RDoc::RI::Driver
- RDoc::RI::Driver::Error
- RDoc::RI::Driver::NotFoundError
- RDoc::RI::Error
- RDoc::RI::Paths
- RDoc::RI::Task
- RDoc::Require
- RDoc::RubygemsHook
- RDoc::Servlet
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Stats::Normal
- RDoc::Stats::Quiet
- RDoc::Stats::Verbose
- RDoc::Store
- RDoc::Store::Error
- RDoc::Store::MissingFileError
- RDoc::Task
- RDoc::Text
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- RDocTask

No matching classes.

# RDoc::Markup::ToMarkdown

Outputs parsed markup as Markdown

### Public Class Methods

new(markup = nil) click to toggle source

Creates a new formatter that will output Markdown format text

                   # File rdoc/markup/to_markdown.rb, line 12
    def initialize markup = nil
      super

      @headings[1] = ['# ',      '']
      @headings[2] = ['## ',     '']
      @headings[3] = ['### ',    '']
      @headings[4] = ['#### ',   '']
      @headings[5] = ['##### ',  '']
      @headings[6] = ['###### ', '']

      add_regexp_handling_RDOCLINK
      add_regexp_handling_TIDYLINK

      @hard_break = "  \n"
    end

### Public Instance Methods

accept_list_end(list) click to toggle source

Finishes consumption of `list`

                   # File rdoc/markup/to_markdown.rb, line 47
    def accept_list_end list
      @res << "\n"

      super
    end

accept_list_item_end(list_item) click to toggle source

Finishes consumption of `list_item`

                   # File rdoc/markup/to_markdown.rb, line 56
    def accept_list_item_end list_item
      width = case @list_type.last
              when :BULLET then
                4
              when :NOTE, :LABEL then
                use_prefix

                4
              else
                @list_index[-1] = @list_index.last.succ
                4
              end

      @indent -= width
    end

accept_list_item_start(list_item) click to toggle source

Prepares the visitor for consuming `list_item`

                   # File rdoc/markup/to_markdown.rb, line 75
    def accept_list_item_start list_item
      type = @list_type.last

      case type
      when :NOTE, :LABEL then
        bullets = Array(list_item.label).map do |label|
          attributes(label).strip
        end.join "\n"

        bullets << "\n:"

        @prefix = ' ' * @indent
        @indent += 4
        @prefix << bullets + (' ' * (@indent - 1))
      else
        bullet = type == :BULLET ? '*' : @list_index.last.to_s + '.'
        @prefix = (' ' * @indent) + bullet.ljust(4)

        @indent += 4
      end
    end

accept_list_start(list) click to toggle source

Prepares the visitor for consuming `list`

                   # File rdoc/markup/to_markdown.rb, line 100
    def accept_list_start list
      case list.type
      when :BULLET, :LABEL, :NOTE then
        @list_index << nil
      when :LALPHA, :NUMBER, :UALPHA then
        @list_index << 1
      else
        raise RDoc::Error, "invalid list type #{list.type}"
      end

      @list_width << 4
      @list_type << list.type
    end

accept_rule(rule) click to toggle source

Adds `rule` to the output

                   # File rdoc/markup/to_markdown.rb, line 117
    def accept_rule rule
      use_prefix or @res << ' ' * @indent
      @res << '-' * 3
      @res << "\n"
    end

accept_verbatim(verbatim) click to toggle source

Outputs `verbatim` indented 4 columns

                   # File rdoc/markup/to_markdown.rb, line 126
    def accept_verbatim verbatim
      indent = ' ' * (@indent + 4)

      verbatim.parts.each do |part|
        @res << indent unless part == "\n"
        @res << part
      end

      @res << "\n"
    end

gen_url(url, text) click to toggle source

Creates a Markdown-style URL from `url` with `text`.

                   # File rdoc/markup/to_markdown.rb, line 140
    def gen_url url, text
      scheme, url, = parse_url url

      "[#{text.sub(%r{^#{scheme}:/*}i, '')}](#{url})"
    end

handle_rdoc_link(url) click to toggle source

Handles `rdoc-` type links for footnotes.

                   # File rdoc/markup/to_markdown.rb, line 149
    def handle_rdoc_link url
      case url
      when /^rdoc-ref:/ then
        $'
      when /^rdoc-label:footmark-(\d+)/ then
        "[^#{$1}]:"
      when /^rdoc-label:foottext-(\d+)/ then
        "[^#{$1}]"
      when /^rdoc-label:label-/ then
        gen_url url, $'
      when /^rdoc-image:/ then
        "![](#{$'})"
      when /^rdoc-[a-z]+:/ then
        $'
      end
    end

handle_regexp_HARD_BREAK(target) click to toggle source

Adds a newline to the output

                   # File rdoc/markup/to_markdown.rb, line 40
    def handle_regexp_HARD_BREAK target
      "  \n"
    end

handle_regexp_RDOCLINK(target) click to toggle source

Converts the rdoc-…: links into a Markdown.style links.

                   # File rdoc/markup/to_markdown.rb, line 187
    def handle_regexp_RDOCLINK target
      handle_rdoc_link target.text
    end

handle_regexp_TIDYLINK(target) click to toggle source

Converts the `RDoc` markup tidylink into a Markdown.style link.

                   # File rdoc/markup/to_markdown.rb, line 169
    def handle_regexp_TIDYLINK target
      text = target.text

      return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/

      label = $1
      url   = $2

      if url =~ /^rdoc-label:foot/ then
        handle_rdoc_link url
      else
        gen_url url, label
      end
    end

init_tags() click to toggle source

Maps attributes to HTML sequences

                   # File rdoc/markup/to_markdown.rb, line 31
    def init_tags
      add_tag :BOLD, '**', '**'
      add_tag :EM,   '*',  '*'
      add_tag :TT,   '`',  '`'
    end