org.testingisdocumenting.znai.website

Class WebSite.Configuration

java.lang.Object

org.testingisdocumenting.znai.website.WebSite.Configuration

Enclosing class:

WebSite

public static class WebSite.Configuration
extends Object

Method Summary

Modifier and Type	Method and Description
WebSite	deployTo(Path path)
Path	getDocRootPath()
Path	getFooterPath()
Path	getGlobalReferencesPath()
WebSite	parseOnly()
WebSite.Configuration	withAdditionalLookupPaths(List<String> additionalLookupPaths)
WebSite.Configuration	withDocumentationType(String documentationType)
WebSite.Configuration	withEnabledPreview(boolean isPreviewEnabled)
WebSite.Configuration	withExtensionsDefPath(Path path)
WebSite.Configuration	withExtraJavaScripts(WebResource... webResources)
WebSite.Configuration	withFileWithLookupPaths(String fileWithLookupPaths)
WebSite.Configuration	withFooterPath(Path path)
WebSite.Configuration	withGlobalPluginParamsPath(Path path)
WebSite.Configuration	withGlobalReferencesPath(Path path)
WebSite.Configuration	withId(String id)
WebSite.Configuration	withLogoRelativePath(String logoRelativePath)
WebSite.Configuration	withMetaFromJsonFile(Path path)
WebSite.Configuration	withPageModifiedTimeStrategy(PageModifiedTimeStrategy modifiedTimeStrategy)
WebSite.Configuration	withReactJsBundle(ReactJsBundle reactJsBundle)
WebSite.Configuration	withRootPath(Path path)
WebSite.Configuration	withTitle(String title)
WebSite.Configuration	withType(String type)
WebSite.Configuration	withValidateExternalLinks(boolean isValidateExternalLinks)
WebSite.Configuration	withWebResources(WebResource... resources)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withDocumentationType

public WebSite.Configuration withDocumentationType(String documentationType)

withRootPath

public WebSite.Configuration withRootPath(Path path)

withFooterPath

public WebSite.Configuration withFooterPath(Path path)

withReactJsBundle

public WebSite.Configuration withReactJsBundle(ReactJsBundle reactJsBundle)

withExtensionsDefPath

public WebSite.Configuration withExtensionsDefPath(Path path)

withGlobalReferencesPath

public WebSite.Configuration withGlobalReferencesPath(Path path)

withGlobalPluginParamsPath

public WebSite.Configuration withGlobalPluginParamsPath(Path path)

withWebResources

public WebSite.Configuration withWebResources(WebResource... resources)

withExtraJavaScripts

public WebSite.Configuration withExtraJavaScripts(WebResource... webResources)

withPageModifiedTimeStrategy

public WebSite.Configuration withPageModifiedTimeStrategy(PageModifiedTimeStrategy modifiedTimeStrategy)

withId

public WebSite.Configuration withId(String id)

withTitle

public WebSite.Configuration withTitle(String title)

withType

public WebSite.Configuration withType(String type)

withFileWithLookupPaths

public WebSite.Configuration withFileWithLookupPaths(String fileWithLookupPaths)

withAdditionalLookupPaths

public WebSite.Configuration withAdditionalLookupPaths(List<String> additionalLookupPaths)

withMetaFromJsonFile

public WebSite.Configuration withMetaFromJsonFile(Path path)

withLogoRelativePath

public WebSite.Configuration withLogoRelativePath(String logoRelativePath)

withEnabledPreview

public WebSite.Configuration withEnabledPreview(boolean isPreviewEnabled)

withValidateExternalLinks

public WebSite.Configuration withValidateExternalLinks(boolean isValidateExternalLinks)

getGlobalReferencesPath

public Path getGlobalReferencesPath()

getDocRootPath

public Path getDocRootPath()

getFooterPath

public Path getFooterPath()

deployTo

public WebSite deployTo(Path path)

parseOnly

public WebSite parseOnly()