Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobjpeters committed Jun 10, 2024
2 parents 197135b + 584cbda commit 051f9fc
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ Typstry.jl is the interface to convert the computational power of Julia into bea

### What is Typst?

Typst is an open-source and relatively new typesetting system (written in Rust 🚀),
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
```julia-repl
julia> using Pkg: add
julia> add("Typstry")
Expand All @@ -41,7 +41,7 @@ julia> using Typstry

## Showcase

```julia
```julia-repl
julia> show_typst(IOContext(stdout, :mode => code), 'a')
"'a'"
Expand Down Expand Up @@ -86,15 +86,33 @@ typst`compile input.typ output.pdf`

### Planned

- Implement Typst formatting for more types
- `Base`
- Standard Library
- Package extensions
- 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
- 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

Expand All @@ -110,3 +128,4 @@ typst`compile input.typ output.pdf`
- [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)

0 comments on commit 051f9fc

Please sign in to comment.