Add 'README.md'

This commit is contained in:
ed barz 2019-12-30 13:34:25 +01:00
parent 8d72995fd5
commit 79d61b7608
1 changed files with 36 additions and 0 deletions

36
README.md Normal file
View File

@ -0,0 +1,36 @@
# MathJax TeX woff
mathjax-tex-woff is a minimal [MathJax](https://www.mathjax.org/) package optimized to work with TeX syntax and woff fonts.
This repo is a copy of [Tibor Simon's Github](https://github.com/tiborsimon/mathjax-minimal-package) without the `MathJax-2.6.1-base` dir.
## Usage
First, in the head of yout html page, load `MathJax.js` with the config setting:
`<script type="text/javascript" async src="path/to/mathjax-tex-woff/MathJax.js?config=TeX-AMS_CHTML"></script>`
Then, before the closing `</body>` tag add the following script:
```
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
tex2jax: {
inlineMath: [ ['$','$'], ["\\(","\\)"] ],
processEscapes: true
}
});
</script>
```
### Styling with CSS
Since this package uses MathJax's CHTML output, the color can be set directly in the html tag.
[Here](https://file.brz9.dev/web/mathjax-tex-woff/exemple/taylor.html) is an exemple
For more info:
* [MathJax Documentation](https://docs.mathjax.org/en/v2.7-latest/tex.html)
* [The original blog post by Tibor Simon](https://tiborsimon.io/articles/web/minimal-mathjax/)
## License
While **MathJax** is released under the [Apache License](https://github.com/mathjax/MathJax-src/blob/master/LICENSE), Tibor Simon made his build available under the [MIT License](https://github.com/tiborsimon/mathjax-minimal-package/blob/master/LICENSE) (wich is an okay thing to do, to the best of my knowledge) so I'll follow his wish.