https://github.com/type-ruby/type-ruby.github.io
The official website for T-Ruby
https://github.com/type-ruby/type-ruby.github.io
ruby t-ruby
Last synced: about 1 month ago
JSON representation
The official website for T-Ruby
- Host: GitHub
- URL: https://github.com/type-ruby/type-ruby.github.io
- Owner: type-ruby
- License: bsd-2-clause
- Created: 2025-12-09T21:53:04.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-01-19T10:04:11.000Z (about 2 months ago)
- Last Synced: 2026-01-19T17:35:45.102Z (about 2 months ago)
- Topics: ruby, t-ruby
- Language: TypeScript
- Homepage: https://type-ruby.github.io/
- Size: 29.1 MB
- Stars: 3
- Watchers: 0
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: news/2025-12-24-introducing-t-ruby.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
T-Ruby Documentation
Type-safe Ruby, the TypeScript way
Documentation •
T-Ruby Repository
---
## About This Repository
This repository contains the source code for the [T-Ruby official documentation website](https://type-ruby.github.io).
The documentation site is built with [Docusaurus](https://docusaurus.io/) and supports multiple languages (English, Korean, Japanese).
## What is T-Ruby?
**T-Ruby** is a typed superset of Ruby that compiles to plain Ruby — just like TypeScript does for JavaScript.
- Write `.trb` files with type annotations
- Compile to standard `.rb` files with **zero runtime overhead**
- Automatically generate `.rbs` signature files for type checkers
```ruby
# input.trb
def greet(name: String): String
"Hello, #{name}!"
end
```
```ruby
# output.rb (compiled)
def greet(name)
"Hello, #{name}!"
end
```
```ruby
# output.rbs (generated)
def greet: (String name) -> String
```
For more information, visit the [T-Ruby repository](https://github.com/type-ruby/t-ruby).
## Local Development
### Prerequisites
- Node.js 20.0 or higher
- pnpm
### Installation
```bash
pnpm install
```
### Start Development Server
```bash
pnpm start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```bash
pnpm build
```
This command generates static content into the `build` directory.
### Deployment
```bash
pnpm deploy
```
This command builds the website and pushes to the `gh-pages` branch for GitHub Pages hosting.
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
## Related Links
- [T-Ruby Repository](https://github.com/type-ruby/t-ruby) - The main T-Ruby compiler
- [Documentation Website](https://type-ruby.github.io) - Live documentation site