# termd

> termd is a Markdown dialect for term definitions: a glossary format with
> one block type (`term`), a status lifecycle, and cross-references —
> built on the Idiomd kernel. termd.dev is the dialect's site; termd is one
> of the Idiomd dialect family (adrmd: decisions, specmd: behavior, uxmd:
> UI, termd: terms), all sharing the same kernel and fence syntax.

A termd document is a glossary. Each `::: term id="..."` block defines one
term: a required `Definition` section plus optional `Scope`, `Usage`,
`Examples` (`+`/`-` prefix = correct/incorrect use), `Synonyms`, `Related`,
`ReplacedBy`, `Sources`. The `status` attribute is one of draft, approved
(default), deprecated, rejected. `Related`/`ReplacedBy` entries reference
other terms' ids. Frontmatter requires `dialect: termd`; the default OKF
document type is `Glossary` — a termd document is simultaneously a valid
Open Knowledge Format document.

Packages (npm): @idiomd/core (kernel), @idiomd/dialect-termd (this
dialect), termd-renderer-html (register + articles), termd-renderer-json
(flat glossary index for AI/tooling).

## Docs

- [Dialect overview](https://termd.dev/docs/): frontmatter, conformance, versioning
- [The term block](https://termd.dev/docs/term-block/): attributes and sections reference
- [Status lifecycle](https://termd.dev/docs/lifecycle/): draft/approved/deprecated/rejected
- [Renderers](https://termd.dev/docs/renderers/): HTML register and JSON index
- [Install](https://termd.dev/install/): packages and quick start

## Source

- [Spec repo](https://gitlab.com/idiomd/dialects/termd/termd-spec): SPEC.md and blocks/term.json are normative
- [Example glossary](https://gitlab.com/idiomd/examples/byline/-/tree/main/docs/glossary): the Byline example project, also showing the recommended folder convention

## Family

- [Idiomd](https://idiomd.com): the kernel and the dialect family