google_api_service_user v0.6.0 GoogleApi.ServiceUser.V1.Model.Page View Source

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

Attributes

  • content (String.t): The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. Defaults to: null.
  • name (String.t): 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: <pre><code>pages: - name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages: - name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. Defaults to: null.
  • subpages ([Page]): Subpages of this page. The order of subpages specified here will be honored in the generated docset. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.ServiceUser.V1.Model.Page{
  content: any(),
  name: any(),
  subpages: [GoogleApi.ServiceUser.V1.Model.Page.t()]
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.