Skip to content

docs: comline doc --format html - #113

Merged
Kinflou merged 1 commit into
mainfrom
docs/doc-html
Nov 1, 2026
Merged

Kinflou merged 1 commit into
mainfrom
docs/doc-html

Conversation

@Kinflou

@Kinflou Kinflou commented Nov 1, 2026

Copy link
Copy Markdown
Member

Documents the official HTML renderer (ComlineProject/generation#98, wired into the CLI by the cli PR):

  • reference/tools/doc.md: --format markdown|html|json and the HTML site's files (index.html, <module>.html, changelog.html, style.css, search.js), search, theme, and why it works offline and from file://.
  • reference/cli.md: the comline doc row.
  • reference/congregation/comline-toml.md: format = "html".
  • guide/documenting.md: "Or as a site of its own", and a note that the std pages are rendered with Markdown as pages of this site.
  • schemas/comline-toml/0.x.json: refreshed from generation#98.

The cli and schema drift checks compare against cli's and generation's default branches, so they fail until those PRs merge. Merge order: generation#98, then comline-rust#87 and comline-typescript#103, then the cli PR, then this one. Rerun the drift checks after that.

Checks run locally: zensical build --strict (no issues).

The CLI reference, the comline doc and comline.toml references and the
documenting guide cover the official HTML renderer: --format html and
[doc] format = "html". schemas/comline-toml/0.x.json is refreshed, and
the guide notes that the std pages are rendered with Markdown, as pages
of this site.
@Kinflou
Kinflou merged commit 22ea26c into main Nov 1, 2026
4 of 5 checks passed
@Kinflou
Kinflou deleted the docs/doc-html branch November 1, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant