ViewModule

PackageFsLiveDocs.Renderer
Contains the view components and layout templates for the documentation site.

Summary

NameSignatureSynopsis
sourceLinkHrefsourceLinkHref repoUrl locationNo description available.
h1WithAnchorh1WithAnchor id title classesNo description available.
h2WithAnchorh2WithAnchor id title classesNo description available.
h3WithAnchorh3WithAnchor id title classesNo description available.
navItemnavItem title urlNo description available.
sidebarPageLinksidebarPageLink rootPath pNo description available.
sidebarEntityLinksidebarEntityLink rootPath eNo description available.
entitiesForPackageentitiesForPackage packageInfo entitiesNo description available.
sidebarsidebar rootPath pages packageNo description available.
apiCardapiCard package repoUrl memberModelNo description available.
layoutlayout pageTitle pages package config versions theme rootPath contentNo description available.

sourceLinkHref

sourceLinkHref repoUrl location
Member

Parameters

NameTypeDescription
repoUrlstring option
locationSourceLink

Returns

string option

h1WithAnchor

h1WithAnchor id title classes
Member

Parameters

NameTypeDescription
idstring
titlestring
classesstring

Returns

XmlNode

h2WithAnchor

h2WithAnchor id title classes
Member

Parameters

NameTypeDescription
idstring
titlestring
classesstring

Returns

XmlNode

h3WithAnchor

h3WithAnchor id title classes
Member

Parameters

NameTypeDescription
idstring
titlestring
classesstring

Returns

XmlNode

navItem

navItem title url
Member

Parameters

NameTypeDescription
titlestring
urlstring

Returns

XmlNode
sidebarPageLink rootPath p
Member

Parameters

NameTypeDescription
rootPathstring
pContentPage

Returns

XmlNode
sidebarEntityLink rootPath e
Member

Parameters

NameTypeDescription
rootPathstring
eEntityModel

Returns

XmlNode

entitiesForPackage

entitiesForPackage packageInfo entities
Member

Parameters

NameTypeDescription
packageInfoPackageInfo
entitiesEntityModel list

Returns

EntityModel list

sidebar

sidebar rootPath pages package
Member

Parameters

NameTypeDescription
rootPathstring
pagesContentPage list
packagePackageModel

Returns

XmlNode

apiCard

apiCard package repoUrl memberModel
Member

Parameters

NameTypeDescription
packagePackageModel
repoUrlstring option
memberModelMemberModel

Returns

XmlNode

layout

layout pageTitle pages package config versions theme rootPath content
Member

Parameters

NameTypeDescription
pageTitlestring
pagesContentPage list
packagePackageModel
configSiteConfig
versionsstring list
themestring
rootPathstring
contentXmlNode list

Returns

XmlNode