home()#

Get the route for the documentation index page, if it exists.

When documentation versioning is enabled, this is the generated redirect page at the documentation root.

DocumentationPage::home(): Hyde\Support\Models\Route

homeRouteName()#

Get the route key for the documentation index page, for example docs/index.

This is always the documentation root, regardless of whether documentation versioning is enabled.

DocumentationPage::homeRouteName(): string

getDocumentationVersion()#

Get the documentation version this page belongs to, or null if documentation versioning is disabled.

$page->getDocumentationVersion(): Hyde\Framework\Features\Documentation\Versioning\DocumentationVersion

getOnlineSourcePath()#

No description provided.

$page->getOnlineSourcePath(): string|false

getRouteKey()#

Get the route key for the page.

If flattened outputs are enabled, this will use the identifier basename so nested pages are flattened. Pages belonging to a documentation version keep the version prefix, so only the structure within the version is flattened.

$page->getRouteKey(): string

getOutputPath()#

Get the path where the compiled page will be saved.

If flattened outputs are enabled, this will use the identifier basename so nested pages are flattened. Pages belonging to a documentation version keep the version prefix, so only the structure within the version is flattened.

$page->getOutputPath(): string