Skip to content

Commit be4c772

Browse files
authored
Merge pull request #295 from mathjax/issue294
documentation for deprecated features
2 parents 9b4ef93 + 0819c1f commit be4c772

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,26 @@ Use
1616

1717
to install mathjax-node and its dependencies.
1818

19-
**Note:**
2019

21-
* mathjax-node no longer includes an API for processing HTML-fragments but can easily be integrated into workflows for processing larger documents.
22-
* the API no longer produces PNG images but can easily be integrated into workflows using svg-to-png converters (e.g., svg2png, librsvg, batik).
23-
* mathjax-node requires Node.js v4 or later.
20+
**Note:**
21+
22+
mathjax-node requires Node.js v4 or later.
23+
24+
25+
**Breaking Changes in v1.0:**
26+
27+
mathjax-node v1.0 dropped the following features that were present in earlier pre-releases.
28+
29+
* `lib/mj-page.js` (API for processing HTML-fragments) and related CLI tools
30+
* speech-rule-engine integration
31+
* PNG generation
32+
33+
These features can easily be recreated in separate modules for greate flexibility. For some community examples, see
34+
35+
* [mathjax-node-page](https://github.com/pkra/mathjax-node-page/)
36+
* [mathjax-node-sre](https://github.com/pkra/mathjax-node-sre)
37+
* [mathjax-node-svg2png](https://github.com/pkra/mathjax-node-svg2png)
38+
2439

2540
# Getting started
2641

0 commit comments

Comments
 (0)