IF Commons GitHub

extensions/docs/markdown

Declarations as Markdown (commons lang-sql 0004-sql-docs FR-007): one section for each declaration that has documentation or members that have it, in the order of the text, always the same text for the same declarations.

toMarkdown(documentScript(parse("-- The people.\nCREATE TABLE person (id INT -- the key\n)")));

Spec: 0004-sql-docs FR-007

Source: commons/lang-sql/src/extensions/docs/markdown.ts

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

toMarkdownfunction
function toMarkdown(declarations: readonly Declaration[], level?: number): string

Writes declarations as Markdown.

ParameterWhat it is
declarationswhat documentScript gave
levelthe heading level of each declaration's section (2 by default)

Returns: the text, ending with a new line

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

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