Madeinterfaceno test imports itinterface MadeWhat a presentation makes: its files, and what it found while making them.
| Member | Type | What it is |
|---|---|---|
files | readonly OutFile[] | The files, by path. |
found | readonly Finding[] | What was found. |
The presentations of the pages (docs 0001-docs FR-007): the pages are one model, and a presentation is a way of writing them as files. There are four. The web is the static site (a page of HTML for each page, the stylesheet, the script, the search index); the markdown is the Markdown twin of each page and llms.txt for a program; the data is the JSON the lenses add; the book is the AsciiDoc of the volumes of a book (docs 0001-docs FR-008). A presentation makes its files in memory, as a list, so that the same list is written (build), or compared with what is on disk (build --check), and the same pages give the same bytes in each.
Madeinterfaceno test imports itinterface MadeWhat a presentation makes: its files, and what it found while making them.
| Member | Type | What it is |
|---|---|---|
files | readonly OutFile[] | The files, by path. |
found | readonly Finding[] | What was found. |
OutFiletypeno test imports ittype OutFile = { readonly path: string; readonly text: string } | { readonly path: string; readonly from: string };A file a presentation makes: its path from the output folder, and its text or the file it is copied from.
PRESENTATIONSconstconst PRESENTATIONS: readonly Presentation[]The presentations there are.
Presentationinterfaceno test imports itinterface PresentationA presentation: a name, and the files it makes of a built site.
| Member | Type | What it is |
|---|---|---|
id | "book" | "data" | "markdown" | "web" | Its name. |
what | string | What it is, in a few words. |
make | (config: Config, built: Built) => Made | Its files. |
presentationFilesfunctionfunction presentationFiles(config: Config, built: Built, ids: readonly ("book" | "data" | "markdown" | "web")[]): MadeThe files of a set of presentations, in the order of the presentations and then of their paths; a path two presentations make is made by the first.
| Parameter | What it is |
|---|---|
config | the configuration |
built | the site |
ids | the presentations |
staleFilesfunctionfunction staleFiles(out: string, files: readonly OutFile[]): Promise<string[]>The files whose text is not what is in a folder: missing, or different.
| Parameter | What it is |
|---|---|
out | the folder |
files | the files that should be there |
writeFilesfunctionfunction writeFiles(out: string, files: readonly OutFile[]): Promise<void>Files written into a folder.
| Parameter | What it is |
|---|---|
out | the folder |
files | the files |