Class Page
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
Implements
Inherited Members
Namespace: Google.Apis.ServiceUsage.v1beta1.Data
Assembly: Google.Apis.ServiceUsage.v1beta1.dll
Syntax
public class Page : IDirectResponseSchema
Properties
Content
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.
Declaration
[JsonProperty("content")]
public virtual string Content { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
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
.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Subpages
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Declaration
[JsonProperty("subpages")]
public virtual IList<Page> Subpages { get; set; }
Property Value
Type | Description |
---|---|
IList<Page> |