Settings

mdoc.internal.cli.Settings
See theSettings companion object
case class Settings(in: List[AbsolutePath], out: List[AbsolutePath], watch: Boolean, check: Boolean, noLinkHygiene: Boolean, checkLinkHygiene: Boolean, verbose: Boolean, site: Map[String, String], classpath: String, scalacOptions: String, cleanTarget: Boolean, noLivereload: Boolean, port: Int, host: String, help: Boolean, usage: Boolean, version: Boolean, markdownExtensions: List[String], include: List[PathMatcher], exclude: List[PathMatcher], reportRelativePaths: Boolean, charset: Charset, cwd: AbsolutePath, allowCodeFenceIndented: Boolean, stringModifiers: List[StringModifier], postModifiers: List[PostModifier], preModifiers: List[PreModifier], inputStream: InputStream, screenWidth: Int, screenHeight: Int, headerIdGenerator: String => String, variablePrinter: Variable => String, coursierLogger: Logger) extends ParserSettings

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait ParserSettings
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addSite(extraVariables: Map[String, String]): Settings
def isExplicitlyExcluded(path: RelativePath): Boolean
def isFileWatching: Boolean
def isIncluded(path: RelativePath): Boolean
def onLoad(reporter: Reporter): Unit
def toInputFile(infile: AbsolutePath): Option[InputFile]
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def withWorkingDirectory(dir: AbsolutePath): Settings

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

val isMarkdownFileExtension: Set[String]
val outputByInput: Map[AbsolutePath, AbsolutePath]