Basic Usage

processor=Qiita::Markdown::Processor.new(hostname:"example.com")processor.call(markdown)# => {#   codes: [#     {#       code: "1 + 1\n",#       language: "ruby",#       filename: "example.rb",#     },#   ],#   mentioned_usernames: [#     "alice",#     "bob",#   ],#   output: "<h1>Example</h1>\n...",# }

Filters

processor=Qiita::Markdown::Processor.new(hostname:"example.com")processor.filters <<HTML::Pipeline::ImageMaxWidthFilterprocessor.call(text)

Context

:allowed_usernames            - A list of usernames allowed to be username. (Array<String>):asset_path                   - URL path to link to emoji sprite. (String):asset_root                   - Base URL to link to emoji sprite. (String):base_url                     - Used to construct links to user profile pages for each. (String):default_language             - Default language used if no language detected from code. (String):emoji_names                  - A list of allowed emoji names. (Array<String>):emoji_url_generator          - #call'able object that accepts emoji name as argument and returns emoji image URL. (#call)                                The original implementation is used when the generator returned a falsey value.:hostname                     - FQDN. Used to check whether or not each URL of `href` attributes is external site. (String):inline_code_color_class_name - Class name for inline code color. (String):language_aliases             - Alias table for some language names. (Hash):markdown                     - A hash for enabling / disabling optional Markdown syntax. (Hash)                                Currently :footnotes (default: true) and :sourcepos (defalut: false) are supported.                                For more information on these options, please see [increments/qiita_marker](https://github.com/increments/qiita_marker).:rule                         - Sanitization rule table. (Hash):script                       - A flag to allow to embed script element. (Boolean)

processor=Qiita::Markdown::Processor.new(asset_root:"http://example.com/assets",hostname:"example.com")processor.call(text)

Rendering Summary

Context

{truncate:{length:100,# Documents will be truncated if it exceeds this character count. (Integer)omission:'…'# A string added to the end of document when it's truncated. (String, nil)}}

processor=Qiita::Markdown::SummaryProcessor.new(truncate:{length:80},hostname:"example.com")processor.call(text)