Merge branch 'develop' for v3.0.1

Author: dpvc

CONTRIBUTING.md

@@ -121,7 +121,8 @@ do you expect to happen instead?
 
 Feature requests are welcome. Before you submit one, be sure to have:
 
-1. **Used the GitHub search** to check that the feature hasn't already
   been requested.
+1. **Used the GitHub search** to check that the feature hasn't already
+   been requested.
 2. Take a moment to think about whether your idea fits with the scope
    and aims of the project, or if it might better fit being a [custom
    extension](https://github.com/mathjax/MathJax-third-party-extensions).
@@ -146,7 +147,14 @@ a refactor, or an improvement to a feature, etc., please be sure to:
 
 ## Working on MathJax core
 
-You want to contribute code? We describe how below.  First, note that the MathJax source code is in the <https://github.com/mathjax/MathJax-src> repository, not the <https://github.com/mathjax/MathJax> repository, which contains the packaged component files for distribution on CDNs and the [mathjax npm package](https://www.npmjs.com/package/mathjax) (the source code is included in the [mathjax-full npm package](https://www.npmjs.com/package/mathjax-src)).
+You want to contribute code? We describe how below.  First, note that
+the MathJax source code is in the
+<https://github.com/mathjax/MathJax-src> repository, not the
+<https://github.com/mathjax/MathJax> repository, which contains the
+packaged component files for distribution on CDNs and the [mathjax npm
+package](https://www.npmjs.com/package/mathjax) (the source code is
+included in the [mathjax-full npm
+package](https://www.npmjs.com/package/mathjax-full)).
 
 ### Key Branches & Tags
 
@@ -155,27 +163,27 @@ MathJax uses several permanent branches in the [MathJax source repository](https
 - **[develop](https://github.com/mathjax/MathJax-src/tree/develop)**
   is the development branch. All work on the next release happens here
   so you should generally branch off `develop` if you are going to
-  submit
 a pull request. Do **NOT** use this branch for a production
+  submit a pull request. Do **NOT** use this branch for a production
   site.
 
 - **[master](https://github.com/mathjax/MathJax-src)** contains the latest
   release of MathJax. This branch may be used in production. Do 
   **NOT** use this branch to work on MathJax's source.
 
 These branches reflect version 3 of MathJax, which is substantially
-different
from the version 2 codebase.  Version 2 will continue to be
-maintained while web
sites transition to version 3, with work being
-done using the following branches 
in the [MathJax distribution
+different from the version 2 codebase.  Version 2 will continue to be
+maintained while web sites transition to version 3, with work being
+done using the following branches in the [MathJax distribution
 repository](https://github.com/mathjax/MathJax):
 
-- **[legacy-v2-develop](https://github.com/mathjax/MathJax/tree/legacy-v2-develop)**

+- **[legacy-v2-develop](https://github.com/mathjax/MathJax/tree/legacy-v2-develop)**
   is the development branch for changes to the legacy version 2 code.
-  Any
 pull requests for version 2 should be branched from here.  Do
-  **NOT** use
 this branch for a production site.
+  Any pull requests for version 2 should be branched from here.  Do
+  **NOT** use this branch for a production site.
 
 - **[legacy-v2](https://github.com/mathjax/MathJax/tree/legacy-v2)**
-  is the
 branch that contains any updates to version 2 following
-  the release of
 version 3.  Do **NOT** use this branch to work on
+  is the branch that contains any updates to version 2 following
+  the release of version 3.  Do **NOT** use this branch to work on
   MathJax's source.
 
 In addition to these branches, MathJax uses tags to identify the

README.md

@@ -1,7 +1,9 @@
 # MathJax
-
 ## Beautiful math in all browsers
 
+<img class="shield" alt="GitHub release version" src="https://img.shields.io/github/v/release/mathjax/MathJax-src?sort=semver"> <img class="shield" alt="GitHub release version (branch)" src="https://img.shields.io/github/package-json/v/mathjax/MathJax/legacy-v2?label=release v2">
+<a class="reference external image-reference" href="http://www.numfocus.org"><img alt="powered-by NumFocus" src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&amp;amp;colorA=E1523D&amp;amp;colorB=007D8A"></a>
+
 MathJax is an open-source JavaScript display engine for LaTeX, MathML,
 and AsciiMath notation that works in all modern browsers.  It was
 designed with the goal of consolidating the recent advances in web
@@ -87,9 +89,11 @@ If you want to host MathJax from your own server, you can do so by
 installing the `mathjax` package using `npm` and moving the `es5`
 directory to an appropriate location on your server:
 
-    npm install mathjax
+    npm install mathjax@3
     mv node_modules/mathjax/es5 <path-to-server-location>/mathjax
 
+Note that we are still making updates to version 2, so include `@3` when you install, since the latest chronological version may not be version 3.
+
 Alternatively, you can get the files via GitHub:
 
     git clone https://github.com/mathjax/MathJax.git mj-tmp
@@ -110,12 +114,13 @@ for details.
 
 ### Using MathJax components in a node application
 
-To use MathJax components in a node application, install the `mathjax`
-package:
+To use MathJax components in a node application, install the `mathjax` package:
+
+    npm install mathjax@3
 
-    npm install mathjax
+(we are still making updates to version 2, so you should include `@3` since the latest chronological version may not be version 3).
 
-and require `mathjax` within your application:
+Then require `mathjax` within your application:
 
     require('mathjax').init({ ... }).then((MathJax) => { ... });
 
@@ -147,7 +152,7 @@ everything other than `tex-chtml.js`, and the `input/tex/extensions`, `output/ch
 
 If you are not using A11Y support (e.g., speech generation, or semantic enrichment), then you can remove `a11y` and `sre` as well (though in this case you may need to disable the assistive tools in the MathJax contextual menu in order to avoid MathJax trying to load them when they aren't there).
 
-If you are using SVG rather that CommonHTML output (e.g., `tex-svg.js` rather than `tex-chtml.js`), you can remove the `output/chtml/fonts/woff-v2` directory.  If you are using MathML input rather than TeX (e.g., `mml-chtml.js` rather than `tex-chtml.js`), then you can remove `input/tex/extensions` as well.
+If you are using SVG rather than CommonHTML output (e.g., `tex-svg.js` rather than `tex-chtml.js`), you can remove the `output/chtml/fonts/woff-v2` directory.  If you are using MathML input rather than TeX (e.g., `mml-chtml.js` rather than `tex-chtml.js`), then you can remove `input/tex/extensions` as well.
 
 
 ## The Component Files and Pull Requests