kit-doc edge

RedcarpetRenderCustom class
Kit::Doc::RedcarpetRenderCustom
View Source

Custom RedCarpet renderer.

References


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

Inheritance: Redcarpet::Render::HTML → Object

Link to this section Class methods 1


Link to this section Instance methods 3

Attempt to identify & add link to objects references between back ticks.

Note: is it not ideal to perform it here, as we have no context for relative references like .class_method or #instance_method. If we want to support this, the replacement needs to be done in the docstring with some regex to identify backtick.

Add hover-link behaviour to Headers.

Bypasses :with_toc_data option so we need to reimplement it ourselves.

References


Link to this section Constants 1

Link to this constant

ANCHOR_STRIPPED_CHARACTERS

View Source

Characters to be removed from anchor links.

' -&+$,/:;=?@"{}#|^~[]`\\*()%.!\''