Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jakobjpeters/Typstry.jl

The Julia to Typst interface
https://github.com/jakobjpeters/Typstry.jl

julia julialang typesetting typst

Last synced: about 2 months ago
JSON representation

The Julia to Typst interface

Host: GitHub
URL: https://github.com/jakobjpeters/Typstry.jl
Owner: jakobjpeters
License: mit
Created: 2023-07-29T13:48:31.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-05-23T00:00:12.000Z (4 months ago)
Last Synced: 2024-05-23T01:06:45.369Z (4 months ago)
Topics: julia, julialang, typesetting, typst
Language: Julia
Homepage: https://jakobjpeters.github.io/Typstry.jl/
Size: 2.69 MB
Stars: 28
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-typst - Typstry.jl - The Julia to Typst interface (Integrations & Tools / Programming)

README

        





# Typstry.jl

[![Documentation stable](https://img.shields.io/badge/Documentation-stable-blue.svg)](https://jakobjpeters.github.io/Typstry.jl/)

[![Documentation development](https://img.shields.io/badge/Documentation-development-blue.svg)](https://jakobjpeters.github.io/Typstry.jl/development/)

[![Continuous Integration](https://github.com/jakobjpeters/Typstry.jl/workflows/Continuous%20Integration/badge.svg)](https://github.com/jakobjpeters/Typstry.jl/actions/workflows/continuous_integration.yml)

[![Documentation](https://github.com/jakobjpeters/Typstry.jl/workflows/Documentation/badge.svg)](https://github.com/jakobjpeters/Typstry.jl/actions/workflows/documentation.yml)

[![Codecov](https://codecov.io/gh/jakobjpeters/Typstry.jl/branch/main/graph/badge.svg?token=XFWU66WSD7)](https://codecov.io/gh/jakobjpeters/Typstry.jl)

[![Dependents](https://juliahub.com/docs/General/Typstry/stable/deps.svg)](https://juliahub.com/ui/Packages/General/Typstry?t=2)



## Introduction

Typstry.jl is the interface to convert the computational power of Julia into beautifully formatted Typst documents.

### What is Typst?

Typst is an open-source and relatively new typesetting system (written in Rust 🦀🚀),

[designed to improve upon the performance and usability of LaTeX](https://typst.app/about).

See also the Typst [repository](https://github.com/typst/typst) and

[documentation](https://typst.app/docs) for examples and how to get started.

## Installation

```julia-repl

julia> using Pkg: add

julia> add("Typstry")

julia> using Typstry

```

## Showcase

```julia-repl

julia> show_typst(IOContext(stdout, :mode => code), true)

true

julia> show(stdout, "text/typst", Typst([true 1; 1.0 [Any[true 1; 1.0 nothing]]]))

$mat(

  "true", 1;

  1.0, mat(

    "true", 1;

    1.0, #none

  )

)$

julia> TypstString(1 // 2; block = true)

typst"$ 1 / 2 $"

julia> typst"$ \(1 + 2im; mode = math) $"

typst"$ (1 + 2i) $"

julia> TypstCommand(["help"])

typst`help`

julia> addenv(typst`compile input.typ output.pdf`, "TYPST_FONT_PATHS" => julia_mono)

typst`compile input.typ output.pdf`

```

## Features

### Strings

- Print Julia values in Typst format

    - Specify Julia settings and Typst parameters

    - Implement formatting for custom types

- Construct Typst strings

    - Interpolate formatted values

    - Render in Pluto.jl notebooks

### Commands

- Construct Typst commands

- Render documents using the Typst compiler

    - Use the [JuliaMono](https://github.com/cormullion/juliamono) typeface

### Planned

- Support rendering in more environments

    - IJulia.jl

    - Quarto?

    - REPL Unicode?

    - Other?

- Default `auto::Mode`?

    - Automatically determine the Typst syntactic context

    - Use a tree-sitter grammar or jll package

- Documenter.jl backend and docstrings

    - Requires Typst to [output HTML](https://github.com/typst/typst/issues/721)

- Implement Typst formatting for more types

    - `Base`

        - `AbstractDict`

        - `AbstractIrrational`

        - `AbstractSet`

        - `Enum`

        - `Expr`

        - `Mode`

        - `Symbol`

    - Package extensions

        - Standard Library

            - Dates.jl

                - `Period` --> `duration`

            - LinearAlgebra.jl

    - A symbolic `TypstFunction`?

        - May faciliate Julia to Typst transpilation

        - Examples

            - `TypstString(TypstFunction(eval, :(1//2); mode = code)) == typst"eval("(1 / 2)", mode: \"code\")"`

            - `TypstString(TypstFunction(*, :a, :b; mode = math)) == typst"(a) (b)"`

## Related Packages

### Typst

- [Labelyst.jl](https://github.com/emanuel-kopp/Labelyst.jl)

- [SummaryTables.jl](https://github.com/PumasAI/SummaryTables.jl)

- [TypstGenerator.jl](https://github.com/onecalfman/TypstGenerator.jl)

- [Typst_jll.jl](https://github.com/JuliaBinaryWrappers/Typst_jll.jl)

### LaTeX

- [Latexify.jl](https://github.com/korsbo/Latexify.jl)

- [LaTeXStrings.jl](https://github.com/JuliaStrings/LaTeXStrings.jl)

- [LatexPrint.jl](https://github.com/scheinerman/LatexPrint.jl)

- [MakieTeX.jl](https://github.com/JuliaPlots/MakieTeX.jl)

    - Supports Typstry.jl

- [MathJaxRenderer.jl](https://github.com/MichaelHatherly/MathJaxRenderer.jl)