smalldocs.check
smalldocs check: build into a scratch folder, and list what smalldocs ignores, cannot read, and the broken links.scan
scan(text: str) -> list[tuple[int, str]]Find Pandoc-only syntax in a page, outside code blocks.
| Parameter | Type | Default | Description |
|---|---|---|---|
text |
str | required | The Markdown of a page |
| returns | list[tuple[int, str]] | The line and the message for each thing smalldocs will not render as Quarto does |
check
check(root: Path) -> intBuild the site into a scratch folder and report every warning, Pandoc-only feature and broken link.
| Parameter | Type | Default | Description |
|---|---|---|---|
root |
Path | required | The project folder |
| returns | int | 0 when there is nothing to report, 1 otherwise |