https://github.com/tectonic-typesetting/tectonic-ruby
Tectonic binding for ruby
https://github.com/tectonic-typesetting/tectonic-ruby
Last synced: 10 days ago
JSON representation
Tectonic binding for ruby
- Host: GitHub
- URL: https://github.com/tectonic-typesetting/tectonic-ruby
- Owner: tectonic-typesetting
- License: mit
- Created: 2018-12-29T08:57:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-25T12:43:45.000Z (about 4 years ago)
- Last Synced: 2025-06-01T06:52:40.206Z (24 days ago)
- Language: Ruby
- Size: 34.2 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Tectonic-ruby [](https://travis-ci.org/tectonic-typesetting/tectonic-ruby)
Tectonic binding for ruby, that is a modernized, complete, embeddable, TeX/LaTeX engine.
## Installation
1. Install all the dev-dependencies of tectonic.
See [Installing Tectonic](https://tectonic-typesetting.github.io/en-US/install.html).
2. Add this line to your application's Gemfile:
```ruby
# gem 'tectonic' # Currently, we haven't pushed this gem to rubygems yet.
gem 'tectonic', github: "tectonic-typesetting/tectonic-ruby"
```
3. And then execute:
```shell
$ bundle
```
## Usage
```ruby
require 'tectonic'
latex = <<-EOS
\\documentclass{article}
\\begin{document}
Hello, Tectonic!
\\end{document}
EOS
pdf = Tectonic.latex_to_pdf(latex)
# geneate a pdf file in the current directory
File.binwrite("out.pdf", pdf.pack("C*"))
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tectonic-typesetting/tectonic-ruby.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).