katex_on_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3872cf936c63cb11367add5f9ad324663ed9bc83d023e55e342af3859658faa5
+  data.tar.gz: 9fd09a1fa1aea8f3ccad7aca1c2ef3dc6e97040a877979caaaf45d733af3a04b
+SHA512:
+  metadata.gz: cdeb03ab1ee3ce3dc1f5a7d7a5fac02a75068877092e43e148d5e3fb27705fccf58e2a935c68810487e151f10937b8f6cc510f4178cf274f9e1781281ac61735
+  data.tar.gz: 7582d254885462db762459c9d4bbda3635b1a35dd699d250fb2e00c28dd37b9e409ed29f7d5d238e271173c7d889a094ddfac84fe4933c42b06e130431739a23

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 (2025-06-28)
+
+- Add `render_to_string` method.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Juraj Kostolanský
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# KaTeX on Rails
+
+Convert LaTeX math formulas to HTML using KaTeX in Rails.
+
+KaTeX on Rails uses [Nodo](https://github.com/mtgrosser/nodo)
+to call the [KaTex](https://katex.org) Node.js package.
+
+## Installation
+
+Add the KaTeX on Rails gem:
+
+```sh
+bundle add katex_on_rails
+```
+
+Or add this line to your Gemfile manually:
+
+```ruby
+gem 'katex_on_rails'
+```
+
+Install the `katex` package with `npm`:
+
+```sh
+npm install katex
+```
+
+Or with `yarn`:
+```sh
+yarn add katex
+```
+
+To render any HTML generated by this gem, you will need to link the CSS file
+from the `katex` Node.js package, make the KaTeX font files available to the client,
+and use the HTML5 doctype. See [browser usage](https://katex.org/docs/browser).
+Note, however, that you do not need to include `katex.js` on the client.
+
+## Usage
+
+```ruby
+katex = KatexOnRails.new
+
+katex.render_to_string('x', { output: 'html' })
+#=> "<span class=\"katex\">..."
+```
+
+The last argument to `render_to_string` can contain a [variety of rendering options](https://katex.org/docs/options).
+
+## License
+
+The KaTeX on Rails gem is is released under the [MIT License](https://opensource.org/licenses/MIT).

data/katex_on_rails.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/katex_on_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'katex_on_rails'
+  spec.version = KatexOnRails::VERSION
+  spec.authors = ['Juraj Kostolansky']
+  spec.email = ['juraj@kostolansky.sk']
+
+  spec.summary = 'Convert LaTeX math formulas to HTML using KaTeX in Rails.'
+  spec.homepage = 'https://github.com/jkostolansky/katex_on_rails'
+  spec.license = 'MIT'
+
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/jkostolansky/katex_on_rails',
+    'source_code_uri' => 'https://github.com/jkostolansky/katex_on_rails',
+    'changelog_uri' => 'https://github.com/jkostolansky/katex_on_rails/blob/main/CHANGELOG.md',
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.files = Dir['README.md', 'LICENSE.txt', 'CHANGELOG.md', 'katex_on_rails.gemspec', 'lib/**/*.rb']
+
+  spec.required_ruby_version = '>= 3.2.0'
+  spec.add_dependency 'nodo', '>= 1.8.0'
+end

data/lib/katex_on_rails/package.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'nodo'
+
+class KatexOnRails
+  class Package < ::Nodo::Core
+    require :katex
+
+    function :render_to_string, code: <<~JS
+      (text, options) => {
+        return katex.renderToString(text, options);
+      }
+    JS
+  end
+end

data/lib/katex_on_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class KatexOnRails
+  VERSION = '0.1.0'
+end

data/lib/katex_on_rails.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'katex_on_rails/version'
+require 'katex_on_rails/package'
+
+class KatexOnRails
+  def render_to_string(text, options = {})
+    katex_package.render_to_string(text, options)
+  end
+
+  private
+
+  def katex_package
+    @katex_package ||= Package.new
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: katex_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juraj Kostolansky
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nodo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description:
+email:
+- juraj@kostolansky.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- katex_on_rails.gemspec
+- lib/katex_on_rails.rb
+- lib/katex_on_rails/package.rb
+- lib/katex_on_rails/version.rb
+homepage: https://github.com/jkostolansky/katex_on_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jkostolansky/katex_on_rails
+  source_code_uri: https://github.com/jkostolansky/katex_on_rails
+  changelog_uri: https://github.com/jkostolansky/katex_on_rails/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Convert LaTeX math formulas to HTML using KaTeX in Rails.
+test_files: []