Skip to main content

Parse, validate, and render

@clidoc/core exposes the OpenCLI schema and the operations used by the CLI and documentation integrations.

import { parse, renderMarkdown, validate } from '@clidoc/core';

const document = parse(source); // JSON or YAML; throws for invalid input
const result = validate(document);
const markdown = renderMarkdown(document);

Use generatePages for a landing page and one page per visible command. See the API reference for signatures and TSDoc descriptions generated from the source.