Metadata-Version: 2.1
Name: wagtailmath
Version: 1.2.0
Summary: Wagtail StreamField block for rendering mathematical equations
Home-page: https://github.com/JamesRamm/wagtailmath
Author: James Ramm
Author-email: jamessramm@gmail.com
License: MIT
Keywords: development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: django (>=3.0)
Requires-Dist: wagtail (>=2.0)

=============================
WagtailMath
=============================

.. image:: https://badge.fury.io/py/wagtailmath.svg
    :target: https://badge.fury.io/py/wagtailmath


WagtailMath allows you to write equations in your `Wagtail <https://github.com/wagtail/wagtail>`_ content using markup and render them beautifully.

WagtailMath provides a ``MathBlock`` so you can write equations in markup (TeX, MathML, ASCIIMath) and render them with MathJax.
It features a live preview:

.. figure:: https://github.com/JamesRamm/wagtailmath/blob/master/docs/images/mathblock.png
    :alt: MathBlock in the Wagtail admin


``MathBlock`` uses MathJax for rendering so there is very little to do on the front end. Simply include
the MathJax JS and render the raw ``MathBlock`` content as you would for any other streamfield plain text block.

WagtailMath even includes a template tag to include the MathJax JS for you from a CDN. 
By default, MathJax is configured to accept all recognised markup (TeX, MathML, ASCIIMath) and renders them to HTML.
To change the configuration, you can pass the desired config command to the templatetag.
See http://docs.mathjax.org/en/latest/config-files.html#combined-configurations for possible configurations.

For help on using the markup languages see the relevant MathJax documentation (e.g. http://docs.mathjax.org/en/latest/tex.html) 
and the markup language-specific documentation (e.g. https://en.wikibooks.org/wiki/LaTeX)

Quickstart
----------

Install wagtailmath::

    pip install wagtailmath

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'wagtailmath',
        ...
    )

Use ``MathBlock`` in your ``StreamField`` content:

.. code-block:: python

    from wagtailmath.blocks import MathBlock

    class MyPage(Page):
        body = StreamField([
            ('heading', blocks.CharBlock(classname="full title")),
            ('paragraph', blocks.RichTextBlock()),
            ('equation', MathBlock())
        ])

Use the ``mathjax`` template tag in your front end template to load the MathJax library:

.. code-block:: django

    {% load wagtailmath %}
    ...

    <script src="{% mathjax %}"></script>





History
-------

1.2.0 (TBD)
++++++++++++++++++

* Upgrade to newer version of Django + Wagtail

0.1.0 (2017-04-24)
++++++++++++++++++

* First release on PyPI.


