If, for some reason, the supplied default files cannot be found - this
exception will be thrown in layouts
.
If, for some reason, the supplied default files cannot be found - this
exception will be thrown in layouts
.
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.
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.
files that are considered compilable end in .md
or .html
Copy static files to outDir
Generate HTML for the API documentation
Generate blog from files in blog/_posts
and output in outDir
Generate HTML files from markdown and .html sources
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 } %}
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.
Render a page to html, the resulting string is the result of the complete expansion of the template with all its layouts and includes.
Sidebar created from sidebar.yml
file in site root
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.
files that are *not* considered static are files ending in a compilable extension.
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