site/build
Build the Construct documentation site (User Guide + Developer Docs).
Docs site, next. Source: site/build.mjs.
Variables#
DEV_STATUS_WINDOW_SEC#
constDEV_STATUS_WINDOW_SEC:900=900
Defined in: site/build.mjs:44
The activity file the docs logo reads: when the newest commit of the branch being built was made. Times only: no names,
no messages, no hashes. lastActivityAt is null when the history is unavailable or repoRoot is not a repository. For tests (and
for a build that must not depend on it), CONSTRUCT_DEV_STATUS_LAST_ACTIVITY overrides it: an ISO time, or none for null.
Functions#
build()#
build(
__namedParameters):Promise<{examples:number;pages:number;searchIndexed:boolean; }>
Defined in: site/build.mjs:58
Parameters#
__namedParameters
api?
boolean = false
basePath
any
buildTime?
Date = ...
out
any
repo
any
repoRoot?
any = REPO_ROOT
search?
boolean = false
version
any
versions
any
visionSnapshot
any
Returns#
Promise<{ examples: number; pages: number; searchIndexed: boolean; }>
devStatus()#
devStatus(
__namedParameters?):object
Defined in: site/build.mjs:45
Parameters#
__namedParameters?
buildTime?
Date = ...
env?
any = process.env
repoRoot?
any = REPO_ROOT
Returns#
object
generatedAt
generatedAt:
string
lastActivityAt
lastActivityAt:
string
version
version:
number=1
windowSec
windowSec:
number=DEV_STATUS_WINDOW_SEC
parseArgs()#
parseArgs(
argv):object
Defined in: site/build.mjs:30
Parameters#
argv
any
Returns#
object
no-api
no-api:
boolean
no-search
no-search:
boolean