pulumi-google-native-kotlin/com.pulumi.googlenative.servicemanagement.v1.kotlin.outputs/PageResponse

PageResponse

data class PageResponse(val content: String, val name: String, val subpages: List<PageResponse>)

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

Constructors

PageResponse

fun PageResponse(content: String, name: String, subpages: List<PageResponse>)

Types

Companion

object Companion

Properties

content

val content: String

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

name

val name: String

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference Java page using Markdown reference link syntax: Java.

subpages

val subpages: List<PageResponse>

Subpages of this page. The order of subpages specified here will be honored in the generated docset.