A Thredded Markdown plugin that renders TeX math via KaTeX (server-side).
Ruby HTML Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
spec
.codeclimate.yml
.gitignore
.rspec
.rubocop.yml
.simplecov
.travis.yml
CHANGES.md
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
thredded-markdown_katex.gemspec

README.md

Thredded Plugin: TeX math in Markdown via KaTex Build Status Test Coverage Code Climate

A Thredded markdown plugin that renders TeX math server-side via KaTeX.

This is what it looks like:

screenshot

Installation

Add this line to your application's Gemfile:

gem 'thredded-markdown_katex'

And then execute:

bundle
rails g thredded:markdown_katex:install

Usage

Wrap math in $$.

See the Kramdown Math documentation for more information.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/glebm/thredded-markdown_katex.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.