PlayDoc

play.doc.PlayDoc

class PlayDoc(markdownRepository: FileRepository, codeRepository: FileRepository, resources: String, playVersion: String, val pageIndex: Option[PageIndex], templates: PlayDocTemplates, pageExtension: Option[String])

Play documentation support

Value parameters

codeRepository: Repository for finding code samples
markdownRepository: Repository for finding markdown files
pageExtension: The extension to add to rendered pages - used for rendering links.
pageIndex: An optional page index. If None, will use the old approach of searching up the heirarchy for sidebar pages, otherwise will use the page index to render the sidebar.
playVersion: The version of Play we are rendering docs for.
resources: The resources path
templates: The templates to render snippets.

Render some markdown.

Render all the pages of the documentation

singlePage: Whether the pages are being rendered to be formatted on a single page

Render a Play documentation page.

Returns: If found a tuple of the rendered page and the rendered sidebar, if the sidebar was found.

In this article

Generated with