IF Commons GitHub

site

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-docs FR-001

One build of the site (commons 0011-documentation FR-003, FR-009, FR-017, FR-018, FR-023, FR-026): the configuration's packages and spec kits read, every page made (the lenses the configuration passes make theirs), the pages that cite each specification added, every link and anchor held to the pages, and the site written as files: a page for each page, the stylesheet, the script, Mermaid and the search index. The same sources give the same bytes.

Source: commons/docs/src/site.ts

2 of 3 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

Builtinterfaceno test imports it
interface Built

A built site: its pages, its search index and what was found while it was built.

MemberTypeWhat it is
pagesreadonly Page[]The pages, in the order they were made.
foundreadonly Finding[]What was found.
filesreadonly SiteFile[]The files the lenses added beside the pages (the JSON of a model).
buildSitefunction
function buildSite(config: Config): Promise<Built>

The site of a repository, built in memory from its configuration.

ParameterWhat it is
configthe configuration, checked

Imported by 63 tests of the run (63 passed, 0 failed): the library's results

writeSitefunction
function writeSite(config: Config, built: Built, out: string, presentations?: readonly ("book" | "data" | "markdown" | "web")[]): Promise<readonly Finding[]>

A built site written into a folder, which is emptied first where the presentations include the site (the web), and not otherwise (a book's files are written into the folder of the books of a repository that holds other things).

ParameterWhat it is
configthe configuration
builtthe site
outthe folder
presentationswhat is written; the configuration's by default

Returns: what was found while the presentations were made (a part of a book that takes no page)

Imported by 3 tests of the run (3 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.