API

Content registry

Experimentalv0.4.0-rc
Version links
Currentv0.4.0-rcChangelogv0.4.0-rc

Registry outputs

  • .typematter/registry.json
  • .typematter/search-index.json

Additional fields

  • contentRoute
  • contentPath
  • language
  • description
  • toc
  • components
  • hidden
  • pager

Use typematter export-registry to generate the registry during builds.

A build-time scan generates a content index that includes routes, titles, ordering, and TOC data.

Fields

  • route
  • title
  • order
  • section
  • status (optional)
  • version (optional)
  • tags (optional)
Caching

The content index is generated at build time and can be cached as JSON for runtime use.