https://github.com/kitbur/ruby-text

A Flarum extension that adds ruby text annotations to forum posts via BBCode.
https://github.com/kitbur/ruby-text

bbcode composer flarum flarum-extension php text

Last synced: 4 months ago
JSON representation

A Flarum extension that adds ruby text annotations to forum posts via BBCode.

• Host: GitHub
• URL: https://github.com/kitbur/ruby-text
• Owner: kitbur
• License: mit
• Created: 2025-06-08T06:24:05.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2025-06-10T21:10:42.000Z (7 months ago)
• Last Synced: 2025-06-16T16:06:04.946Z (6 months ago)
• Topics: bbcode, composer, flarum, flarum-extension, php, text
• Language: PHP
• Homepage:
• Size: 89.8 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Flarum Ruby Text

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kitbur/ruby-text/blob/main/LICENSE.md)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/kitbur/ruby-text.svg)](https://packagist.org/packages/kitbur/ruby-text)

A Flarum extension that allows the use of ruby text in forum posts using BBCode. Ruby is commonly used for phonetic guides or brief annotative notes that render above text.

### Features

- Adds a `[ruby]` BBCode for text annotations.

### Usage

Forum post syntax:

```bbcode

This is some [ruby=top text]annotated[/ruby] text.

```

Here's how it looks:

![Screenshot of the Ruby Text extension](https://raw.githubusercontent.com/kitbur/ruby-text/main/docs/screenshots/ruby-text-demo.png)

### Installation

```bash

composer require kitbur/ruby-text

```

### Links

- [Packagist](https://packagist.org/packages/kitbur/ruby-text)

- [GitHub](https://github.com/kitbur/ruby-text)

- [Flarum Community](https://discuss.flarum.org/d/37564-ruby-text-add-annotation-text-to-your-forum-posts)

- [Flarum Extension](https://flarum.org/extension/kitbur/ruby-text)

---

Copyright © 2025 kitbur. Licensed under the MIT License.