Code Monkey home page Code Monkey logo

mathjax-ext-contrib's Introduction

MathJax Contributed Extensions

Each directory listed contains a MathJax extension which can be used in a document with the MathJax CDN configuration.

A typical configuration using one of these extensions will include the following within the <head>...</head> portion of your HTML document:

<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  TeX: {
    extensions: ["http://cs.jsu.edu/mathjax-ext/github/extname/extname.js"] 
  }
});
</script>
<script type="text/javascript"
  src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>

Please note the extension URL: this is not on GitHub, but is updated nightly from the GitHub master branch.

Some extensions may require additional configuration -- for details, see the README in the directory for the extension.

The extensions can also be downloaded and stored for local use -- just be sure to change the URL in the loadComplete() call at the end of the extension JavaScript file, and the URL in the MathJax configuration.

Each extension also has a sample page, which can be found in the gh-pages branch.

License

All extensions here are made available as source code, under terms of the Apache license version 2.0 -- see the file License.txt listed above for terms and details. Author attributions and copyright notices are contained in each file or its associated README.md file. Unless otherwise noted there, copyright remains with the author, with reuse and redistribution only permitted subject to the terms of the license.

If you wish to submit an extension, the instructions are below, but be aware that your material will be available here under the same terms, i.e. as source code and under the terms of the Apache license version 2.0. For the purposes of this repository, issuing a pull request constitutes an implicit agreement to having these license terms applied to your materials.

Notes for MathJax version 2.1

All extensions have been tested with MathJax version 2.1 on the CDN.

Notes for MathJax version 2.0

All extensions have been tested with MathJax version 2.0 on the CDN.
This did require minor bug fixes in the forminput and forloop extensions (the corrections do not affect function in MathJax version 1.1).

For Extension Developers

Developers are welcome to place their extensions here (by issuing a pull request), but please observe the following guidelines:

  1. Directory and file naming: Please place your extension in a separate directory, extname, and place the main JavaScript file for the extension, extname.js, in that directory (replace extname with the name of your extension).

  2. README: Please include a README.md file in the extname directory with configuration and usage documentation -- see the existing extensions for examples.

  3. Sample: Please include a sample file sample.html in the extname directory in the gh-pages branch, with a sample demonstrating configuration and usage of your extension, and link to the sample in your README.md file. (You will need to make a separate pull request for your commit to the gh-pages branch.)

  4. URLs: For testing purposes, a raw.github.com URL is acceptable on a temporary basis, but before you make your pull request to merge into the master branch, please change the URL to http://cs.jsu.edu/mathjax-ext/github/extname/extname.js in the loadComplete() call at the end of extname.js and in the configuration block of your sample.

  5. MathJax CDN: Please test your extension against the MathJax CDN as shown in the configuration above, and set up your sample file to use the CDN.

Please note that your files will not be available immediately on the cs.jsu.edu URL -- this site is updated nightly from the master branch here. Also please note that the sample file sample.html in the gh-pages branch is not transfered to the cs.jsu.edu site -- the URL for the sample will be http://leathrum.github.com/mathjax-ext-contrib/extname/sample.html.

mathjax-ext-contrib's People

Contributors

leathrum avatar dpvc avatar

Stargazers

 avatar Ger Hobbelt avatar Robert W. avatar Jack Liu Shurui avatar lyrachord avatar Hendrik Väli avatar Nikos M. avatar Jean Kaplansky avatar Sergey Yungman avatar zohooo avatar Ivan Shvedunov avatar 陈杨文 avatar Jamie Freeman avatar Charles Anifowose avatar Stefan Norberg avatar  avatar Mateusz Kulesza avatar

Watchers

James Cloos avatar Charles Anifowose avatar  avatar Yukai Chou avatar

mathjax-ext-contrib's Issues

Bower Manifests and Registration

Hey,
It would be super useful if these plugins were registered with bower. Bower is a nice JS dependency management tool. You basically just have to add a manifest file, tag your repository, and then register the package via the command line.

Thanks!
Chris

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.