patrick/KaTeX
1
0
Fork 0
mirror of https://github.com/Smaug123/KaTeX synced 2025-10-08 20:48:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make a more working example in README. Fix #1049 (#1050)

Browse Source 
This is an attempt to flesh out the required <head> tags needed to make a full
working example of autorender, including KaTeX itself, to help people get
started with KaTeX.
This commit is contained in:
Erik Demaine
2017-12-31 16:01:30 -08:00
committed by Kevin Barabash
parent 159cf422bc
commit d6609f7319
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
contrib/auto-render/README.md
View File

@@ -6,10 +6,13 @@ renders the math in place.
### Usage ### Usage
This extension isn't part of KaTeX proper, so the script should be separately This extension isn't part of KaTeX proper, so the script needs to be included
included in the page: (via a `<script>` tag) in the page along with KaTeX itself. For example,
using a CDN:
```html ```html
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0-alpha2/katex.min.css" integrity="sha384-exe4Ak6B0EoJI0ogGxjJ8rn+RN3ftPnEQrGwX59KTCl5ybGzvHGKjhPKk/KC3abb" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0-alpha2/katex.min.js" integrity="sha384-OMvkZ24ANLwviZR2lVq8ujbE/bUO8IR1FdBrKLQBI14Gq5Xp/lksIccGkmKL8m+h" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0-alpha2/contrib/auto-render.min.js" integrity="sha384-cXpztMJlr2xFXyDSIfRWYSMVCXZ9HeGXvzyKTYrn03rsMAlOtIQVzjty5ULbaP8L" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0-alpha2/contrib/auto-render.min.js" integrity="sha384-cXpztMJlr2xFXyDSIfRWYSMVCXZ9HeGXvzyKTYrn03rsMAlOtIQVzjty5ULbaP8L" crossorigin="anonymous"></script>
``` ```
@@ -90,4 +93,4 @@ in addition to two auto-render-specific keys:
Note that the `displayMode` property of the options object is ignored, and is Note that the `displayMode` property of the options object is ignored, and is
instead taken from the `display` key of the corresponding entry in the instead taken from the `display` key of the corresponding entry in the
`delimiters` key. `delimiters` key.