DoqContentTarget

Overview

One documentation version: its authored pages, where the resolved Markdown goes and what it may read.

• Kind: Interface

Declaration

interface DoqContentTarget

Properties

Name	Type	Description
name?	string	Unique name, also the @name of cross-version API links. Optional for a single target (defaults to "current").
authoring	string	Directory of authored pages and _-prefixed fragments, relative to the project.
out	string	Directory the resolved pages are written to (usually the Analog content directory). Never overwritten files you wrote.
sourceRoots?	string[]	Directories ::source may read from. Without any, ::source is refused.
api?	string[]	Directories generated by doq-api whose .doq-api.json supplies the symbol index for [[api:Name]].
sourceUrl?	string	Link template for "View source", http(s)://… with {path} and optionally {revision} and {lines}.
revision?	string	Replaces {revision} in sourceUrl: a tag or commit. Never guessed.
sourcePathPrefix?	string	Prepended to the project-relative path in {path} (for a monorepo package directory).
sourceLines?	string	Replaces {lines} for a region or range. Default #L{start}-L{end}.