Skip to main content

Module teach_md

Module teach_md 

Source
Expand description

Markdown rendering for the shared teaching brain (logicaffeine_language::teach) — the LSP’s presentation of a lesson.

One renderer feeds hover AND completion documentation, so the two can never phrase a lesson differently; the terminal REPL renders the same lessons in ANSI. The quickguide link goes through guide_url — one function to change if the guide ever moves off the repository.

Functions§

block_hover_md
The lesson for a ## block header, keeping the Block Header banner.
completion_docs
The lesson as completion-item documentation (same rendering as hover — the editor’s docs panel and the hover card always agree).
guide_url
The canonical “read more” URL for a quickguide heading slug.
keyword_hover_md
The full lesson as hover markdown: name, one plain sentence, the runnable example, the socratic question or tip, and the guide link when one fits.