https://github.com/thredded/thredded-markdown_katex

A Thredded Markdown plugin that renders TeX math via KaTeX (server-side).
https://github.com/thredded/thredded-markdown_katex

Last synced: about 1 year ago
JSON representation

A Thredded Markdown plugin that renders TeX math via KaTeX (server-side).

• Host: GitHub
• URL: https://github.com/thredded/thredded-markdown_katex
• Owner: thredded
• License: mit
• Created: 2017-01-22T18:29:58.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-02-17T13:39:33.000Z (over 3 years ago)
• Last Synced: 2025-04-17T14:22:02.296Z (about 1 year ago)
• Language: Ruby
• Homepage:
• Size: 50.8 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Thredded Plugin: TeX math in Markdown via KaTex [![Build Status](https://travis-ci.org/thredded/thredded-markdown_katex.svg?branch=main)](https://travis-ci.org/thredded/thredded-markdown_katex) [![Test Coverage](https://codeclimate.com/github/thredded/thredded-markdown_katex/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded-markdown_katex/coverage) [![Code Climate](https://codeclimate.com/github/thredded/thredded-markdown_katex/badges/gpa.svg)](https://codeclimate.com/github/thredded/thredded-markdown_katex)

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

This is what it looks like:

![screenshot](https://cloud.githubusercontent.com/assets/216339/22184709/a7799d12-e0cf-11e6-89dc-a0bf2206f98e.png)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'thredded-markdown_katex'

```

And then execute:

```bash

bundle

rails g thredded:markdown_katex:install

```

## Usage

Wrap math in `$$`.

See the [Kramdown Math documentation](https://kramdown.gettalong.org/syntax.html#math-blocks)

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](https://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](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of

the [MIT License](http://opensource.org/licenses/MIT).

[KaTeX]: https://github.com/Khan/KaTeX