Files
klammertext/README.md
T
ack f9af1ff869 kdesc --typeface from the reflection klammerset; a missing font directory is a row, not an error
Assembled from klammertext-dev daad6273483a. The font-store listing is
rendered from ref/ (one table per search directory, in search order,
with the styles each typeface holds); the search path is described,
not validated, so a KLAMMERTEXT_FONTS directory that does not exist --
the default ~/.klammertext/fonts on a fresh install -- is a row saying
so and the command exits 0. A typeface an earlier directory also holds
is marked shadowed, with the winning directory, in a column present only
when needed. The store's layout convention has one reader,
fonts_in_directory(). Six kdesc suite cases pin the listing.
2026-09-23 17:36:35 +02:00

2.3 KiB

Klammertext

Klammertext is a markup language that produces multiple output formats — HTML, LaTeX/PDF, and plain text — from a single source description. Its core engine, the Klammermachine, is written in C++; the Standard Klammer Set (SKS) adds a default library of formatting and document-structuring operators on top.

Installing

Installation guides are in doc/install/:

  • Linux, from source — doc/install/linux_source_install.md
  • macOS, from source — doc/install/macos_source_install.md
  • Linux, container — doc/install/linux_container_install.md
  • macOS, container — doc/install/macos_container_install.md

Building from source

With a C++20 compiler and KLAMMERTEXT_HOME set to this directory:

make -C com

This builds the Klammermachine library (into lib/), the SKS components, and the three commands — ktext, kdesc, kdiag (into bin/). See the source-install guide for prerequisites (TeX Live for PDF output, Python, and so on).

Working with an AI assistant

If you use a language model to help write Klammertext, give it doc/klammertext_for_llm.md. It is a dense reference written for a model rather than a person: the syntax, the things a model is most likely to assume wrongly about it (Klammertext is not LaTeX, Markdown, or Lisp, and reads oddly if you expect any of them), and how to ask the kdesc and kdiag commands for the current state of the machine instead of guessing.

Editor support

Editing support for Emacs, Sublime Text, Vim, and Visual Studio Code — syntax highlighting, delimiter matching, structural reindentation, table alignment, diagnostics — is in doc/edit/, together with the shared implementation and the Klammertext language server they build on.

Provenance

This repository is a curated snapshot of Klammertext's private development tree, assembled by a manifest-driven script. Its history is a series of release snapshots, not a mirror of the development history, and files here are regenerated on each release — patches cannot be merged directly. Report problems (or send patches) to the author; accepted changes are applied to the development tree and appear in a following snapshot.

This snapshot was assembled from development commit daad6273483a.

License

See LICENSE.md.