Skip to content

HyperMD/hypermd-katex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hypermd-katex

In HyperMD, Use KaTeX to render TeX formulars.

Demo | GitHub | NPM version

How to use

  1. install katex and hypermd-katex
  2. import before creating HyperMD editor
  3. create HyperMD editor

For webpack / parcel

First of all, install the packages: npm install --save hypermd-katex katex

import * as HyperMD from "hypermd"
import "hypermd-katex"

const your_textarea = document.getElementById('input-box')
const editor = HyperMD.fromTextArea(your_textarea)

For requirejs (example)

In your HTML:

<textarea id="input-box" cols="30" rows="10">I'm using $\KaTeX$ now!</textarea>

<script src="https://cdn.jsdelivr.net/npm/requirejs/require.js"></script> <!-- 👈 RequireJS -->
<script src="https://cdn.jsdelivr.net/npm/hypermd/goods/patch-requirejs.js"></script> <!-- 👈 IMPORTANT -->
<script data-main src="main.js"></script>

In your main.js

// before defining your main entry, don't forget :
requirejs.config({
  packages: [
    { name: 'hypermd-katex', main: 'index.js' },
    { name: 'katex', main: 'dist/katex.min.js' },
  ]
})

// then, add "hypermd-katex" to your main-entry's dependency list.

Finally, here is an example of main.js and a live demo.

For Plain Browser Env

Why hurting yourself? The bundlers and module loaders are the future!

See the source of example file

Develop

  1. (if needed) update pbe.manifest.json and define modules' global var name
  2. npm run dev
  3. Start dev, reload page and test