LinkDirectives
Provides the implementation for the link directives included in Laika.
These include:
api
: Convenience directive that allows to reference an api documentation entry (e.g. scaladoc, javadoc)source
: Convenience directive that allows to reference a hosted source (e.g. on GitHub)
For full documentation see the section about Navigation Directives in the manual.
Value members
Concrete fields
Implementation of the api
directive that creates links to API documentation based
on a specified fully-qualified type name. The type name is the only (required) attribute
of the directive.
Implementation of the api
directive that creates links to API documentation based
on a specified fully-qualified type name. The type name is the only (required) attribute
of the directive.
The directive relies on base URIs defined in the transformation's configuration and will otherwise fail. See laika.rewrite.link.LinkConfig for details.
Implementation of the source
directive that creates links to hosted sources based
on a specified fully-qualified type name or a path to markup source file.
The type name or path is the only (required) attribute of the directive.
Implementation of the source
directive that creates links to hosted sources based
on a specified fully-qualified type name or a path to markup source file.
The type name or path is the only (required) attribute of the directive.
The directive relies on base URIs defined in the transformation's configuration and will otherwise fail. See laika.rewrite.link.LinkConfig for details.