Page class

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

Constructors

Page({Input<String>? content, Input<String>? name, Input<List<Page>>? subpages})
Creates a new Page. 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. 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. subpages Subpages of this page. The order of subpages specified here will be honored in the generated docset.
const
Page.fromMap(Map<String, dynamic> map)
factory

Properties

content → Input<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.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subpages → Input<List<Page>>?
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited