object Markdown

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Markdown
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final val DeprecatedInternal: String("Methods in the `mdoc.internal` package are only intended to be used by mdoc itself so they are subject to breaking changes without notice. If you rely on this method, please open an issue to discuss how to expose it through the public mdoc library APIs https://github.com/scalameta/mdoc/")
  5. val InputKey: DataKey[Option[Input]]
  6. val RelativePathKey: DataKey[Option[RelativePath]]
  7. val SiteVariables: DataKey[Option[Map[String, String]]]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def baseSettings(): MutableDataSet
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. def collect[A <: Node, B](node: Node)(f: PartialFunction[A, B])(implicit arg0: ClassTag[A]): List[B]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def foreach(node: Node)(fn: (Node) => Unit): Unit
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def mdocSettings(context: Context): MutableDataSet

    Defines the default markdown settings.

    Defines the default markdown settings.

    Do not use directly. The default flexmark settings have special keys set up by mdoc to keep track of certain document-specific information like path.

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def parse(markdown: BasedSequence, settings: MutableDataSet): Node
  23. def plainSettings(): MutableDataSet
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toDocument(input: Input, markdownSettings: MutableDataSet, reporter: Reporter, settings: Settings): Document
  26. def toHtml(input: Input, markdownSettings: MutableDataSet, reporter: Reporter, settings: Settings): String
  27. def toMarkdown(input: Input, markdownSettings: MutableDataSet, reporter: Reporter, settings: Settings): String
  28. def toMarkdown(input: Input, context: Context, inputFile: InputFile, siteVariables: Map[String, String], reporter: Reporter, settings: Settings): String
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. def traverse[T <: Node](node: Node)(f: PartialFunction[T, Unit])(implicit ev: ClassTag[T]): Unit
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def toMarkdown(input: Input, context: Context, relativePath: RelativePath, siteVariables: Map[String, String], reporter: Reporter, settings: Settings): String
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.0) Methods in the mdoc.internal package are only intended to be used by mdoc itself so they are subject to breaking changes without notice. If you rely on this method, please open an issue to discuss how to expose it through the public mdoc library APIs https://github.com/scalameta/mdoc/

Inherited from AnyRef

Inherited from Any

Ungrouped