Skip to content
/ XyJax-v3 Public
forked from sonoisa/XyJax-v3

Xy-pic extension for MathJax version 3

License

Notifications You must be signed in to change notification settings

dpvc/XyJax-v3

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

XyJax v3

-- Xy-pic extension for MathJax version 3 --

CAUTION:
THE CURRENT VERSION IS IN ALPHA-QUALITY.
DEPENDING ON YOUR MathJax SETTINGS, IT MAY CRASH.
IT IS NOT YET RECOMMENDED FOR USE IN PRODUCTION.


XyJax is an almost Xy-pic compatible extension for MathJax version 3.

This extension enables you to draw various graphs and diagrams.

See https://sonoisa.github.io/xyjax-v3/xyjax-v3.html for more details. And origins

This software is under development.

Installation instructions

UNDER CONSTRUCTION

(ref. test/sample-xyjax-v3.html)

  1. Download build/xypic.js. The rest of the files are not necessary for use.

  2. In your html, configure it to load the xypic.js you downloaded.

<script>
  MathJax = {
    loader: {
      load: ['[custom]/xypic.js'],
      paths: {custom: '.'}  // specify the path where xypic.js is located. 
                            // This example assumes that xypic.js is in the same place as html.
    },
    tex: {
      packages: {'[+]': ['xypic']}
    }
  };
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js"></script>

Present Limitation

  • Supported MathJax version:

    • 3.1.2
  • Supported Renderer:

    • CHTML
    • (SVG does not work now. But I have a plan to support it.)
  • Accessibility does not work.
    CAUTION: If Accessibility or Collapsible Math is enabled, XyJax/MathJax will crash.

For Developpers

UNDER CONSTRUCTION

How to build xypic.js for production

$ git clone https://github.com/sonoisa/XyJax-v3 XyJax-v3
$ cd XyJax-v3
$ npm install
$ npm run clean
$ npm run build

Hot to build MathJax and xypic.js for debugging

$ git clone https://github.com/sonoisa/XyJax-v3 XyJax-v3
$ cd XyJax-v3
$ npm install
# npm run build_mathjax_for_debug
$ npm run clean
$ npm run build

About

Xy-pic extension for MathJax version 3

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.0%
  • HTML 11.0%