https://github.com/actsasflinn/typst-rb
Ruby binding to typst, a new markup-based typesetting system that is powerful and easy to learn.
https://github.com/actsasflinn/typst-rb
Last synced: about 1 month ago
JSON representation
Ruby binding to typst, a new markup-based typesetting system that is powerful and easy to learn.
- Host: GitHub
- URL: https://github.com/actsasflinn/typst-rb
- Owner: actsasflinn
- License: apache-2.0
- Created: 2023-11-24T04:00:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-09T00:09:35.000Z (about 1 year ago)
- Last Synced: 2024-08-09T13:44:29.832Z (9 months ago)
- Language: Rust
- Homepage:
- Size: 4.92 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-typst - typst-rb - Ruby binding to typst (Integrations & Tools / Programming)
README
# typst-rb
Ruby binding to [typst](https://github.com/typst/typst),
a new markup-based typesetting system that is powerful and easy to learn.
## Installation
```bash
gem install typst
```
## Usage
```ruby
require "typst"
# Compile `readme.typ` to PDF and save as `readme.pdf`
Typst::Pdf.new("readme.typ").write("readme.pdf")
# Or return PDF content as an array of bytes
pdf_bytes = Typst::Pdf.new("readme.typ").bytes
# => [37, 80, 68, 70, 45, 49, 46, 55, 10, 37, 128 ...]
# Or return PDF content as a string of bytes
document = Typst::Pdf.new("readme.typ").document
# => "%PDF-1.7\n%\x80\x80\x80\x80\n\n4 0 obj\n<<\n /Type /Font\n /Subtype ..."
# Compile `readme.typ` to SVG and save as `readme_0.svg`, `readme_1.svg`
Typst::Svg.new("readme.typ").write("readme.svg")
# Or return SVG content as an array of pages
pages = Typst::Svg.new("readme.typ").pages
# => [" ["\x89PNG\r\n\x1A\n\x00\x00\x00\rIHDR\x00\x00\x04\xA7\x00\x00\x06\x94\b\ ...
# Compile `readme.typ` to SVG and save as `readme.html`
Typst::Html.new("readme.typ", title: "README").write("readme.html")
# Or return HTML content
markup = Typst::Html.new("readme.typ", title: "README").document
# => "\n\n\n\nREADME\n\n "\n\n \n \n..."
# Compile from a string to PDF
t = Typst::Pdf.from_s(%{hello world})
# Compile from a string to SVG
t = Typst::Svg.from_s(%{hello world})
# Compile from a string to PNG
t = Typst::Png.from_s(%{hello world})
# Compile from a string to SVG multi-frame/pages wrapped in HTML (non-native Typst)
t = Typst::Html.from_s(%{hello world})
# Compile from a string to single frame HTML (native Typst experimental feature)
t = Typst::HtmlExperimental.from_s(%{hello world})
# A more complex example of compiling from string
main = %{
#import "template.typ": *
#show: template.with()
#lorem(50)
#image("icon.svg")
}
template = %{
#let template(body) = {
set text(12pt, font: "Example")
body
}
}
icon = File.read("icon.svg")
font_bytes = File.read("Example.ttf")
t = Typst::Pdf.from_s(main, dependencies: { "template.typ" => template, "icon.svg" => icon }, fonts: { "Example.ttf" => font_bytes })
# From a zip file that includes a main.typ
# zip file include flat dependencies included and a fonts directory
Typst::Pdf::from_zip("working_directory.zip")
# From a zip with a named main typst file
Typst::Pdf::from_zip("working_directory.zip", "hello.typ")
Typst::Query.new("heading", "readme.typ").result
# =>
# [{"func" => "heading",
# "level" => 1,
# "depth" => 1,
# ...
Typst::Query.new("heading", "readme.typ", format: "json").result(raw: true)
# => "[\n {\n \"func\": \"heading\",\n \"level\": 1,\n \"depth\": ..."
Typst::Query.new("heading", "readme.typ", format: "yaml").result(raw: true)
# => "- func: heading\n level: 1\n depth: 1\n offset: 0\n numbering: ..."
```
## Contributors & Acknowledgements
typst-rb is based on [typst-py](https://github.com/messense/typst-py) by [messense](https://github.com/messense)
## License
This work is released under the Apache-2.0 license. A copy of the license is provided in the [LICENSE](./LICENSE) file.