Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 2.81 KB

readme.md

File metadata and controls

78 lines (59 loc) · 2.81 KB

HTMLTeX

This is a JS+CSS tool for making HTML behave and look like LaTeX.

See a live Example here.

Usage

Include the following in the head of your HTML doc:

<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- MathJax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-MML-AM_CHTML"></script>

<!-- HTMLTeX -->
<script src="https://PeterEFrancis.com/HTMLTeX/HTMLTeX.js"></script>
<link rel="stylesheet" href="https://PeterEFrancis.com/HTMLTeX/HTMLTeX.css">

Create an element in the body of the HTML doc that you would like to make look like LaTeX. Then include this script at the bottom of the page. Make sure the first argument to the HTMLTeX constructor is your intended LaTeX element.

<script type="text/x-mathjax-config">
  new HTMLTeX(document.getElementById('LaTeX'), MathJax).render(
    // options
  );
</script>

render() can take an optional JSON with the following optional keys:

  • highlight_links: (true/false)
    • Set to true for cyan outlines of links

New and modified HTML Tags for use

The benefit of HTMLTeX is the easy use of new and modified HTML tags. The list below describes the possible tag attributes and their purpose.

New Tags

  • <tableofcontents> display the table of contents (sections)

  • <section> create section header

    • id: unique ID for use of on-page ref links

  • numbered block environments: <definition>, <lemma>, <theorem>, <proposition>, <corollary>

    • id: unique ID for use of on-page ref links
    • title: bolded title

  • un-numbered block environment: <example>, <remark>

    • id: unique ID for use of on-page ref links
    • title: bolded title

  • <example-modal> example modal environment (requires bootstrap jquery)

    • button activated modal displaying example text
    • outside: (true/false) set button to be outside the body text
      <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
  
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstr`ap.min.js"></script>```

  • <proof> proof environment

    • collapse: (true/false) set mode of proof box to be collapsable or not
    • open: (true/false) set default mode for collapsable proof box to be open

  • <ref> in-page reference link

    • to: id of referenced tag

  • <references> references section

  • <item> reference in the references section

    • id: unique ID for use of on-page cite links

Modified Tags

  • <br> line break (extra line)
  • <hr> horizontal line (grey)
  • <table>
    • id: unique ID for use of on-page refs links
    • caption: Custom Table Caption
  • <cite> in-page citation link
    • to: id of referenced references item