scalatex.site

Highlighter

Related Docs: object Highlighter | package site

trait Highlighter extends AnyRef

Lets you instantiate a Highlighter object. This can be used to reference snippets of code from files within your project via the .ref method, often used via hl.ref where hl is a previously-instantiated Highlighter.

Self Type
Highlighter
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Highlighter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class lang(name: String) extends Product with Serializable

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. def ahk: lang

  5. def as: lang

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def asciidoc: lang

  8. def autoResources: Seq[Path]

  9. def clj: lang

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def coffee: lang

  12. def diff: lang

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. def erl: lang

  16. def ex: lang

  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def fs: lang

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. def highlight(string: String, lang: String): TypedTag[String]

    Highlight a short code snippet with the specified language

  22. def highlightJs: Path

  23. def hs: lang

  24. def hx: lang

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. def js: lang

  27. val languages: Set[String]

  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  29. def nim: lang

  30. final def notify(): Unit

    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  32. def pathMappings: Seq[(Path, String)]

    A mapping of file-path-prefixes to URLs where the source can be accessed.

    A mapping of file-path-prefixes to URLs where the source can be accessed. e.g.

    Seq( "clones/scala-js" -> "https://github.com/scala-js/scala-js/blob/master", "" -> "https://github.com/lihaoyi/scalatex/blob/master" )

    Will link any code reference from clones/scala-js to the scala-js github repo, while all other paths will default to the scalatex github repo.

    If a path is not covered by any of these rules, no link is rendered

  33. def rb: lang

  34. def ref[S, V](filePath: BasePath[_], start: S = Nil, end: V = Nil, className: String = null)(implicit arg0: RefPath[S], arg1: RefPath[V]): TypedTag[String]

    Grab a snippet of code from the given filepath, and highlight it.

    Grab a snippet of code from the given filepath, and highlight it.

    filePath

    The file containing the code in question

    start

    Snippets used to navigate to the start of the snippet you want, from the beginning of the file

    end

    Snippets used to navigate to the end of the snippet you want, from the start of start of the snippet

    className

    An optional css class set on the rendered snippet to determine what language it gets highlighted as. If not given, it defaults to the class given in suffixMappings

  35. def referenceText[S, V](filepath: Path, start: S, end: V)(implicit arg0: RefPath[S], arg1: RefPath[V]): (Int, Int, String)

  36. def scala: lang

  37. def sh: lang

  38. def style: String

  39. def suffixMappings: Map[String, String]

    A mapping of file name suffixes to highlight.js classes.

    A mapping of file name suffixes to highlight.js classes. Usually something like:

    Map( "scala" -> "scala", "js" -> "javascript" )

  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  41. def toString(): String

    Definition Classes
    AnyRef → Any
  42. def ts: lang

  43. def vb: lang

  44. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. def webjars: Path

  48. def xml: lang

Inherited from AnyRef

Inherited from Any

Ungrouped