site/build-all

Build every version of the documentation site into ONE directory (GitHub Pages replaces the whole site).

Docs site, next. Source: site/build-all.mjs.

Functions#

buildAll()#

buildAll(__namedParameters): object

Defined in: site/build-all.mjs:51

Plan and build all versions into out. run builds one ref (injectable for tests). Returns the plan plus what was written.

Parameters#

__namedParameters

nextRef?

string = 'HEAD'

out

any

repo?

string = DEFAULT_REPO

repoDir?

any = REPO_ROOT

run?

(__namedParameters) => void = buildRef

search?

boolean = true

tags

any

Returns#

object

builds

builds: object[]

versions

versions: object[]

---

buildRef()#

buildRef(__namedParameters): void

Defined in: site/build-all.mjs:29

Build one ref into dest by running that ref's own site/build.mjs inside a temporary worktree.

Parameters#

__namedParameters

args

any

dest

any

ref

any

repoDir

any

scratch

any

Returns#

void

---

listTags()#

listTags(repoDir): any

Defined in: site/build-all.mjs:26

Parameters#

repoDir

any

Returns#

any