Convert Typst to INI

Why Convert Typst to INI?

Converting Typst documents to INI format extracts the document's metadata and structured content into a simple key-value configuration format. This is useful when you need to capture document properties like title, author, sections, and key data points in a format that can be easily parsed by scripts, configuration management tools, and automated workflows.

The INI format's simplicity makes it ideal for integration with systems that need to consume document metadata without processing the full markup. Headings from the Typst document become section headers in the INI file, and content within each section is represented as key-value pairs. Variables defined with #let in Typst map naturally to INI key-value entries.

This conversion is particularly useful for document management systems, automated publishing pipelines, and configuration-driven workflows where document metadata needs to be stored in a lightweight, easily parseable format. The resulting INI file can be read by Python's configparser, PHP's parse_ini_file(), or any other INI parsing library.

Key Benefits of Converting Typst to INI:

• Metadata Extraction: Capture document title, author, and properties
• Script Friendly: Easily parsed by Python, PHP, Java, and shell scripts
• Configuration Use: Use document data in configuration-driven systems
• Simple Format: Human-readable key-value pairs with sections
• Automation: Feed document metadata into CI/CD pipelines
• Lightweight: Minimal file size with no formatting overhead
• Universal Support: INI parsers available in every programming language

Practical Examples

Example 1: Document Metadata Extraction

Input Typst file (report.typ):

#set document(
  title: "Annual Report 2025",
  author: "Jane Smith",
)

= Annual Report 2025
== Executive Summary
Revenue grew by *18%* year over year.

== Financial Results
#table(
  columns: 2,
  [Metric], [Value],
  [Revenue], [$3.2M],
  [Profit], [$850K],
)

Output INI file (report.ini):

[document]
title = Annual Report 2025
author = Jane Smith

[executive_summary]
content = Revenue grew by 18% year over year.

[financial_results]
revenue = $3.2M
profit = $850K

Example 2: Configuration from Variables

Input Typst file (config.typ):

#let app_name = "MyApp"
#let version = "2.1.0"
#let author = "Dev Team"

= #app_name Configuration

== Settings
- Debug mode: *disabled*
- Log level: _info_
- Max connections: 100

== Database
- Host: localhost
- Port: 5432
- Name: myapp_db

Output INI file (config.ini):

[document]
app_name = MyApp
version = 2.1.0
author = Dev Team

[settings]
debug_mode = disabled
log_level = info
max_connections = 100

[database]
host = localhost
port = 5432
name = myapp_db

Example 3: Project Documentation Metadata

Input Typst file (project.typ):

#set document(
  title: "Project Specification",
  author: "Engineering Team",
)

= Project Specification

== Requirements
- Platform: Linux, macOS, Windows
- Language: Rust
- License: MIT

== Timeline
- Phase 1: Q1 2026
- Phase 2: Q2 2026
- Release: Q3 2026

Output INI file (project.ini):

[document]
title = Project Specification
author = Engineering Team

[requirements]
platform = Linux, macOS, Windows
language = Rust
license = MIT

[timeline]
phase_1 = Q1 2026
phase_2 = Q2 2026
release = Q3 2026

Frequently Asked Questions (FAQ)

Q: What is INI format?

A: INI is a simple configuration file format using sections (in [brackets]) and key=value pairs. It originated from early Windows systems but is now used across all platforms. Common examples include php.ini, .gitconfig, and desktop.ini. The format is human-readable and easy to parse programmatically.

Q: How are Typst headings mapped to INI sections?

A: Typst headings (=, ==, ===) are converted to INI section headers in [brackets]. The heading text is normalized to a valid section name (lowercase, underscores replacing spaces). Content under each heading becomes key-value pairs within that section.

Q: What happens to Typst formatting in INI?

A: Text formatting markers like *bold* and _italic_ are stripped during conversion since INI is a plain text format with no formatting capabilities. Only the text content is preserved as values in the key-value pairs.

Q: How are Typst #let variables converted?

A: Typst variables defined with #let are converted directly to INI key-value pairs. For example, #let version = "2.0" becomes version = 2.0 in the INI output. This makes Typst variables immediately accessible as configuration values.

Q: Can I parse the INI output with Python?

A: Yes. Python's built-in configparser module reads INI files directly. Use config = configparser.ConfigParser() and config.read('output.ini') to access sections and key-value pairs. This makes it easy to integrate document metadata into Python scripts and applications.

Q: How are Typst tables handled in INI format?

A: Table data is converted to key-value pairs where the first column typically becomes the key and subsequent columns become the value. If a table has headers, they may be used to construct descriptive key names. Complex multi-column tables are flattened to fit INI's key-value structure.

Q: Are comments preserved in the INI output?

A: The converter may add INI comments (lines starting with ; or #) to provide context about the source document structure. Original Typst comments are not typically included, but the section headers and key names are chosen to be self-documenting.

Q: What happens to Typst math expressions in INI?

A: Math expressions are converted to their plain text representation. For example, $ x^2 + y^2 = r^2 $ becomes a value like formula = x^2 + y^2 = r^2. INI format does not support mathematical notation, so only the textual content is preserved.