Jekyll::Euclid

This is a Jekyll converter that converts .euclid files before they are processed by Jekyll. The converter offers a very simple way to write theorems, proofs, and other mathematical content in a Jekyll site. The converter is still under development and it is being based on LaTeX theoremsi.

Install the gem and add to the application's Gemfile by executing:

bundle add jekyll-euclid

If bundler is not being used to manage dependencies, install the gem by executing:

gem install jekyll-euclid

To use the converter, add the following to the _config.yml file:

plugins:
  - jekyll-euclid

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 the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/gnakayama/jekyll-euclid.

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