Additional configuration options for a preview server.
- Value parameters:
- apiDir
an optional API directory from which API documentation should be served (default None)
- artifactBasename
the base name for PDF and EPUB artifacts linked by the generated site (default "docs")
- includeEPUB
indicates whether EPUB downloads should be included on a download page (default false)
- includePDF
indicates whether PDF downloads should be included on a download page (default false)
- isVerbose
whether each served page and each detected file change should be logged (default false)
- pollInterval
the interval at which input file resources are polled for changes (default 1 second)
- port
the port the server should run on (default 4242)
- Companion:
- object
Value members
Concrete methods
Indicates that each served page and each detected file change should be logged to the console.
Indicates that each served page and each detected file change should be logged to the console.
Specifies a directory from which API documentation of the site can be served. This step is only necessary if you want to test links to API documentation with the preview server.
Specifies a directory from which API documentation of the site can be served. This step is only necessary if you want to test links to API documentation with the preview server.
Specifies the base name for PDF and EPUB artifacts linked by the generated site (default "docs"). Additional classifiers might be added to the base name (apart from the file suffix), depending on configuration.
Specifies the base name for PDF and EPUB artifacts linked by the generated site (default "docs"). Additional classifiers might be added to the base name (apart from the file suffix), depending on configuration.
Indicates that EPUB downloads should be included on the download page.
Indicates that EPUB downloads should be included on the download page.
Specifies the host the server should run on (default localhost).
Specifies the host the server should run on (default localhost).
Indicates that PDF downloads should be included on the download page.
Indicates that PDF downloads should be included on the download page.
Specifies the interval at which input file resources are polled for changes (default 1 second).
Specifies the interval at which input file resources are polled for changes (default 1 second).