IF Commons GitHub

Documentation generator

0001

Quality: 113 tests: 113 passed, 0 failed, 0 skipped, 31 of 31 requirements proved, 0 open issues, 0 open tickets. The tests and issues of the library

The library of IFC Docs, @intellectual-frontiers/commons/docs (commons 0011-documentation FR-021, FR-023, FR-026): the configuration's types and its check, the command line's parts, the build of a site and its writing, and what a lens is given and uses (the build, the areas and their API, the page model and its helpers). A repository's docs.config.ts needs only the types; a lens imports the rest from here.

Entry points

Modules

Examples

import { buildSite, loadConfig, report } from "@intellectual-frontiers/commons/docs";
const config = await loadConfig("docs.config.ts");
if (config.kind === "ok") console.log(report((await buildSite(config.value)).found));

Limits

What the modules of this area do not do, or do only in part, as each module's @limits says.

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