kit-doc
kit-doc

edge

kit-doc edge

TemplateHelper class
Kit::Doc::Services::Utils::TemplateHelper
View Source

Template like class to call htmlify.

Link to this section Summary ⚠️ Private APIs are currently hidden.

Inheritance: Object
Used instance mixins: 2 elements

YARD::Templates::Helpers::BaseHelper

YARD::Templates::Helpers::HtmlHelper

Defined in: lib/kit/doc/services/utils.rb#34

Instance methods 6

#html_markup_markdown(text)

Overidden to add `:with_toc_data` to `RedCarpet`.
#htmlify(text, markup = options.markup)

Overriden to remove syntax highlighting with `parse_codeblocks`.
#initialize(object:) RUBYConstructor

A new instance of TemplateHelper.
#options

#to_html(content:, markup:, yard_code_object: nil)

#url_for(obj, anchor = nil, relative = true)

Overriden to remove relative links, as path are not nested with `Kit::Doc::Yard::FileSerializer`.

Included from YARD::Templates::Helpers::HtmlHelper

#htmlify(text, markup = options.markup)

Overriden to remove syntax highlighting with `parse_codeblocks`.
#html_markup_markdown(text)

Overidden to add `:with_toc_data` to `RedCarpet`.
#url_for(obj, anchor = nil, relative = true)

Overriden to remove relative links, as path are not nested with `Kit::Doc::Yard::FileSerializer`.

Instance attributes 2

.current_yard_code_object

Quite an ugly hack to keep track of the current CodeObject being rendered for RedCarpet.
#file RUBYReadonly

Returns the value of attribute file.

Link to this section Instance methods 6

Link to this method

#html_markup_markdown(text)

View Source 
          Originally defined in: YARD::Templates::Helpers::HtmlHelper

Overidden to add :with_toc_data to RedCarpet.

References

Link to this method

#htmlify(text, markup = options.markup)

View Source 
          Originally defined in: YARD::Templates::Helpers::HtmlHelper

Overriden to remove syntax highlighting with parse_codeblocks.

References

Link to this method

#initialize(object:)

View Source RUBYConstructor
Link to this method

#options

View Source
Link to this method

#to_html(content:, markup:, yard_code_object: nil)

View Source
Link to this method

#url_for(obj, anchor = nil, relative = true)

View Source 
          Originally defined in: YARD::Templates::Helpers::HtmlHelper

Overriden to remove relative links, as path are not nested with Kit::Doc::Yard::FileSerializer.

References

Link to this section Instance attributes 2

Link to this method

.current_yard_code_object

View Source

Quite an ugly hack to keep track of the current CodeObject being rendered for RedCarpet.

Link to this method

#file

View Source RUBYReadonly

Returns the value of attribute file.