pkl.DocsiteInfo0.25.1

Overview
Properties
Methods

module pkl.DocsiteInfo

Template for docsite-info.pkl, the descriptor for a Pkldoc website.

Module URI:: pkl:DocsiteInfo
Pkl version:: 0.25.1 or higher
Known subtypes:
Known usages:
All versions:

A website generated by Pkldoc can optionally have a descriptor that

amends this template
is named docsite-info.pkl
is passed to the pkldoc command together with the modules to generate documentation for.

A typical descriptor looks as follows:

/// The optional overview documentation displayed on the main page of the website.
///
/// Subsequent paragraphs are separated by an empty line and collapsed by default.
/// They can use *Markdown syntax* and Pkldoc links such as [String].
amends "pkl:DocsiteInfo"

title = "Title displayed in the header of each page"

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

title: String?

The title of this Pkldoc website.

This is displayed in the header of each page.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```