Packages

class Main extends Site

A default Main implementation you can subclass if you do not need the flexibility given by constructing your Site manually.

Hooks up all the common components (Highlighter, Section, etc) in a common configuration.

Linear Supertypes
Site, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Main
  2. Site
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Main(url: String, wd: Path, output: Path, extraAutoResources: Seq[ResourcePath], extraManualResources: Seq[ResourcePath], frag: ⇒ scalatags.Text.all.Frag)

Type Members

  1. type Body = Frag[Builder, String]
    Definition Classes
    Site
  2. type Header = Seq[scalatags.Text.all.Frag]

    Enable pages to specify multiple header entries

    Enable pages to specify multiple header entries

    Definition Classes
    Site
  3. type Page = (Header, Body)
    Definition Classes
    Site

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 def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def autoResources: Seq[ResourcePath]

    Resources that get automatically included in the bundled js or css file

    Resources that get automatically included in the bundled js or css file

    Definition Classes
    Main → Site
  6. def bodyFrag(frag: scalatags.Text.all.Frag): scalatags.Text.all.SeqFrag[scalatags.Text.all.Frag]

    The body of this site's HTML page

    The body of this site's HTML page

    Definition Classes
    Main → Site
  7. def bundleResources(outputRoot: Path): Unit
    Definition Classes
    Site
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. def content: Map[String, (Seq[scalatags.Text.all.Frag], scalatags.Text.all.Frag)]

    The contents of the site.

    The contents of the site. Maps String paths to the pages, to their actual content.

    Definition Classes
    Main → Site
  10. def defaultHeader: Seq[scalatags.Text.all.Frag]

    The header of this site's HTML page

    The header of this site's HTML page

    Definition Classes
    Site
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def fontAwesome: ResourcePath
    Definition Classes
    Site
  14. def fontAwesomeResources: Seq[ResourcePath]

    Resources related to the font awesome library

    Resources related to the font awesome library

    Definition Classes
    Site
  15. def generateHtml(outputRoot: Path): Unit
    Definition Classes
    Site
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. lazy val hl: Highlighter
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def lnk(name: String, customUrl: String = ""): TypedTag[String]
  21. def main(args: Array[String]): Unit
  22. def manualResources: Seq[ResourcePath]

    Resources copied to the output folder but not included on the page by default

    Resources copied to the output folder but not included on the page by default

    Definition Classes
    Main → Site
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def pageTitle: Option[String]

    Default

    Default

    Definition Classes
    Main → Site
  27. def pureCss: Seq[ResourcePath]

    Resources related to the pure-css library

    Resources related to the pure-css library

    Definition Classes
    Site
  28. def renderTo(outputRoot: Path): Unit
    Definition Classes
    Site
  29. def scriptName: String

    The name of the javascript file that all javascript resources get bundled into

    The name of the javascript file that all javascript resources get bundled into

    Definition Classes
    Site
  30. val sect: Section
  31. def siteCss: Set[ResourcePath]

    Resources custom-provided for this particular site

    Resources custom-provided for this particular site

    Definition Classes
    Site
  32. def stylesName: String

    The name of the css file that all css resources get bundled into

    The name of the css file that all css resources get bundled into

    Definition Classes
    Site
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. val usedLinks: Buffer[String]
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. val wd: Path
  40. def webjars: ResourcePath
    Definition Classes
    Site

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Site

Inherited from AnyRef

Inherited from Any

Ungrouped