From 823a000bcb685831069b86c9214aba7db29436e9 Mon Sep 17 00:00:00 2001 From: "Tate, Hongliang Tian" <tatetian@gmail.com> Date: Thu, 26 Mar 2015 21:40:43 +0800 Subject: [PATCH] Mention the necessity of setting up KaTeX in README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 6725ef0..2342206 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,12 @@ your HTML files: <script src="//path/to/pseudocode/pseudocode.min.js"></script> ``` +Pseudocode.js uses [KaTeX](https://github.com/Khan/KaTeX) to render math +formulas. So if you want to include any math formulas in +your pseudocode, make sure that [KaTeX is +setup](https://github.com/Khan/KaTeX#usage). + + Assume the pseudocode to be rendered is in a `<pre>` DOM element: ```html <pre id="hello-world-code" style="display:hidden;"> -- GitLab