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 blogInfo(implicit ctx: Context): Array[BlogPost]

   

   Attributes

   protected

6. def blogposts(implicit ctx: Context): Array[File]

   

   All files that are considered blogposts, currently this means that files have been placed in:

   All files that are considered blogposts, currently this means that files have been placed in:

   ./blog/_posts/year-month-day-title.ext

   where ext is either markdown or html.

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def compilableFiles(implicit ctx: Context): Array[File]

   

   All files that are considered compilable assets in this context.

   All files that are considered compilable assets in this context. This is mainly markdown and html files, but could include other files in the future.

   Note

   files that are considered compilable end in .md or .html

9. def copyStaticFiles(outDir: File = ...)(implicit ctx: Context): Site.this.type

   

   Copy static files to outDir

10. val documentation: Map[String, Package]

    

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

    

    Definition Classes

    AnyRef

12. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

13. def generateApiDocs(outDir: File = ...)(implicit ctx: Context): Site.this.type

    

    Generate HTML for the API documentation

14. def generateBlog(outDir: File = ...)(implicit ctx: Context): Site.this.type

    

    Generate blog from files in blog/_posts and output in outDir

15. def generateHtmlFiles(outDir: File = ...)(implicit ctx: Context): Site.this.type

    

    Generate HTML files from markdown and .html sources

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

    

    Definition Classes

    AnyRef → Any

17. def getResource(r: String): String

    

    Attributes

    protected

    Definition Classes

    ResourceFinder

18. val includes: Map[String, Include]

    

    Include files are allowed under the directory _includes.

    Include files are allowed under the directory _includes. These files have to be compilable files and can be used with liquid includes:

    {% include "some-file" %}

    You can also use the with statement:

    {% include "some-file" with { key: value } %}

19. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

20. val layouts: Map[String, Layout]

    

    Files that define a layout then referred to by layout: filename-no-ext in yaml front-matter.

    Files that define a layout then referred to by layout: filename-no-ext in yaml front-matter.

    The compiler will look in two locations, <root>/_layouts/ and in the bundled jar file's resources /_layouts.

    If the user supplies a layout that has the same name as one of the defaults, the user-defined one will take precedence.

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

    

    Definition Classes

    AnyRef

22. final def notify(): Unit

    

    Definition Classes

    AnyRef

23. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

24. val projectTitle: String

    

25. def render(page: Page, params: Map[String, AnyRef] = Map.empty)(implicit ctx: Context): Option[String]

    

    Render a page to html, the resulting string is the result of the complete expansion of the template with all its layouts and includes.

26. val root: File

    

27. val sidebar: Sidebar

    

    Sidebar created from sidebar.yml file in site root

28. def staticAssets(implicit ctx: Context): Array[File]

    

    All files that are considered static in this context, this can be anything from CSS, JS to images and other files.

    All files that are considered static in this context, this can be anything from CSS, JS to images and other files.

    Note

    files that are *not* considered static are files ending in a compilable extension.

29. def stripRoot(f: File): String

    

    This function allows the stripping of the path that leads up to root.

    This function allows the stripping of the path that leads up to root.

    scala stripRoot(new JFile("/some/root/dir/css/index.css")) // returns: dir/css/index.css // given that root is: /some/root

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

    

    Definition Classes

    AnyRef

31. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

32. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

33. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )