# ash_typst v0.4.0 - Table of Contents

> Precompiled NIFs and tooling to render Typst documents.

## Pages

- [Home](readme.md)

- Topics
  - [Get Started](get-started.md)
  - [Templating](templating.md)
  - [Multi-Language Documents](multi-language.md)
  - [Sensitive Data](sensitive-data.md)

- Reference
  - [AshTypst.Resource](dsl-ashtypst-resource.md)

- About AshTypst
  - [Change Log](changelog.md)

## Modules

- Core
  - [AshTypst](AshTypst.md): Precompiled Rust NIFs for rendering [Typst](https://typst.app) documents from Elixir.
  - [AshTypst.Code](AshTypst.Code.md): Protocol to support Typst code syntax.

  - [AshTypst.Context](AshTypst.Context.md): Persistent Typst rendering context.
  - [AshTypst.ContextPool](AshTypst.ContextPool.md): Pool of reusable `AshTypst.Context`s.
  - [AshTypst.Document](AshTypst.Document.md): Wrapper struct for rendered Typst documents.
  - [AshTypst.PathResolver](AshTypst.PathResolver.md): Resolves DSL path values to absolute filesystem paths at runtime.
  - [AshTypst.Sigil](AshTypst.Sigil.md): Provides the `~TYPST` sigil for Typst markup.
  - [AshTypst.Type.Document](AshTypst.Type.Document.md): Custom Ash type for `%AshTypst.Document{}`.

- Results & Diagnostics
  - [AshTypst.BundleResult](AshTypst.BundleResult.md): Result of a successful `AshTypst.Context.export_bundle/2`.
  - [AshTypst.CompileError](AshTypst.CompileError.md): Returned as `{:error, %AshTypst.CompileError{}}` when compilation or export
fails.
  - [AshTypst.CompileResult](AshTypst.CompileResult.md): The result of a successful `AshTypst.Context.compile/1`.
  - [AshTypst.Diagnostic](AshTypst.Diagnostic.md): A single compiler diagnostic (error or warning) produced by Typst.
  - [AshTypst.Span](AshTypst.Span.md): A source location range within a Typst file, attached to an
`AshTypst.Diagnostic` or `AshTypst.TraceItem`.
  - [AshTypst.TraceItem](AshTypst.TraceItem.md): One entry in an `AshTypst.Diagnostic`'s call trace, identifying a step in the
chain of function calls that led to the diagnostic.

- Resource
  - [AshTypst.Resource](AshTypst.Resource.md): Spark DSL extension for rendering Typst templates as Ash generic actions.
  - [AshTypst.Resource.Info](AshTypst.Resource.Info.md): Introspection functions for the `AshTypst.Resource` extension.
  - [AshTypst.Resource.Render](AshTypst.Resource.Render.md): Struct and schema for the `render` entity in the `typst` DSL section.
  - [AshTypst.Resource.Render.PdfOptions](AshTypst.Resource.Render.PdfOptions.md): Struct and schema for the `pdf_options` sub-entity of a render action.
  - [AshTypst.Resource.Render.Read](AshTypst.Resource.Render.Read.md): Struct and schema for the `read` sub-entity of a render action.
  - [AshTypst.Resource.Template](AshTypst.Resource.Template.md): Struct and schema for the `template` entity in the `typst` DSL section.

- Exceptions
  - [AshTypst.Resource.Errors.CompileError](AshTypst.Resource.Errors.CompileError.md): Ash-compatible error wrapping Typst compilation diagnostics.