Skip to content

Commit 1d5ce98

Browse files
committed
Merge branch 'develop' for 3.0.1
2 parents bbd6eb4 + 0eb1705 commit 1d5ce98

File tree

119 files changed

+2935
-1968
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+2935
-1968
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,8 @@ do you expect to happen instead?
121121

122122
Feature requests are welcome. Before you submit one, be sure to have:
123123

124-
1. **Used the GitHub search** to check that the feature hasn't already
 been requested.
124+
1. **Used the GitHub search** to check that the feature hasn't already
125+
been requested.
125126
2. Take a moment to think about whether your idea fits with the scope
126127
and aims of the project, or if it might better fit being a [custom
127128
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:
146147

147148
## Working on MathJax core
148149

149-
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)).
150+
You want to contribute code? We describe how below. First, note that
151+
the MathJax source code is in the
152+
<https://github.com/mathjax/MathJax-src> repository, not the
153+
<https://github.com/mathjax/MathJax> repository, which contains the
154+
packaged component files for distribution on CDNs and the [mathjax npm
155+
package](https://www.npmjs.com/package/mathjax) (the source code is
156+
included in the [mathjax-full npm
157+
package](https://www.npmjs.com/package/mathjax-full)).
150158

151159
### Key Branches & Tags
152160

@@ -155,27 +163,27 @@ MathJax uses several permanent branches in the [MathJax source repository](https
155163
- **[develop](https://github.com/mathjax/MathJax-src/tree/develop)**
156164
is the development branch. All work on the next release happens here
157165
so you should generally branch off `develop` if you are going to
158-
submit a pull request. Do **NOT** use this branch for a production
166+
submit a pull request. Do **NOT** use this branch for a production
159167
site.
160168

161169
- **[master](https://github.com/mathjax/MathJax-src)** contains the latest
162170
release of MathJax. This branch may be used in production. Do
163171
**NOT** use this branch to work on MathJax's source.
164172

165173
These branches reflect version 3 of MathJax, which is substantially
166-
differentfrom the version 2 codebase. Version 2 will continue to be
167-
maintained while websites transition to version 3, with work being
168-
done using the following branches in the [MathJax distribution
174+
different from the version 2 codebase. Version 2 will continue to be
175+
maintained while web sites transition to version 3, with work being
176+
done using the following branches in the [MathJax distribution
169177
repository](https://github.com/mathjax/MathJax):
170178

171-
- **[legacy-v2-develop](https://github.com/mathjax/MathJax/tree/legacy-v2-develop)**
179+
- **[legacy-v2-develop](https://github.com/mathjax/MathJax/tree/legacy-v2-develop)**
172180
is the development branch for changes to the legacy version 2 code.
173-
Any pull requests for version 2 should be branched from here. Do
174-
**NOT** use this branch for a production site.
181+
Any pull requests for version 2 should be branched from here. Do
182+
**NOT** use this branch for a production site.
175183

176184
- **[legacy-v2](https://github.com/mathjax/MathJax/tree/legacy-v2)**
177-
is the branch that contains any updates to version 2 following
178-
the release of version 3. Do **NOT** use this branch to work on
185+
is the branch that contains any updates to version 2 following
186+
the release of version 3. Do **NOT** use this branch to work on
179187
MathJax's source.
180188

181189
In addition to these branches, MathJax uses tags to identify the

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# MathJax (Source Repository)
2+
<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">
3+
<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>
24

35
## Beautiful math in all browsers
46

@@ -65,12 +67,13 @@ Repository](https://github.com/mathjax/MathJax-demos-web) for more information.
6567

6668
### Using MathJax Components in node applications
6769

68-
To use MathJax components in a node application, install the `mathjax`
69-
package:
70+
To use MathJax components in a node application, install the `mathjax` package:
7071

71-
npm install mathjax
72+
npm install mathjax@3
7273

73-
and require `mathjax` within your application:
74+
(we are still making updates to version 2, so you should include `@3` since the latest chronological version may not be version 3).
75+
76+
Then require `mathjax` within your application:
7477

7578
require('mathjax').init({ ... }).then((MathJax) => { ... });
7679

@@ -120,8 +123,8 @@ If you want to work from the GitHub repository directly, then do the following:
120123

121124
git clone https://github.com/mathjax/MathJax-src.git mathjax-src
122125
cd mathjax-src
123-
npm run compile
124-
npm run make-components
126+
npm run --silent compile
127+
npm run --silent make-components
125128

126129
in order to compile the JavaScript files from the TypeScript source,
127130
and build the component files from the JavaScript files.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import './lib/assistive-mml.js';
2+
3+
import {AssistiveMmlHandler} from '../../../../js/a11y/assistive-mml.js';
4+
5+
if (MathJax.startup) {
6+
MathJax.startup.extendHandler(handler => AssistiveMmlHandler(handler));
7+
}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"component": "a11y/assistive-mml",
3+
"targets": ["a11y/assistive-mml.ts"]
4+
}
5+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
const PACKAGE = require('../../../webpack.common.js');
2+
3+
module.exports = PACKAGE(
4+
'a11y/assistive-mml', // the package to build
5+
'../../../../js', // location of the MathJax js library
6+
[ // packages to link to
7+
'components/src/input/mml/lib',
8+
'components/src/core/lib'
9+
],
10+
__dirname // our directory
11+
);

components/src/dependencies.js

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
"use strict";
2-
Object.defineProperty(exports, '__esModule', {value: true});
3-
4-
exports.dependencies = {
1+
export const dependencies = {
52
'a11y/semantic-enrich': ['input/mml', '[sre]', 'input/mml'],
63
'a11y/complexity': ['a11y/semantic-enrich'],
74
'a11y/explorer': ['a11y/semantic-enrich', 'ui/menu'],
@@ -32,10 +29,10 @@ exports.dependencies = {
3229
'[tex]/verb': ['input/tex-base']
3330
};
3431

35-
exports.paths = {
32+
export const paths = {
3633
tex: '[mathjax]/input/tex/extensions',
3734
sre: '[mathjax]/sre/sre_browser'
38-
}
35+
};
3936

4037
const allPackages = [
4138
'[tex]/action',
@@ -61,7 +58,7 @@ const allPackages = [
6158
'[tex]/verb'
6259
];
6360

64-
exports.provides = {
61+
export const provides = {
6562
'startup': ['loader'],
6663
'input/tex': [
6764
'input/tex-base',
@@ -78,4 +75,4 @@ exports.provides = {
7875
...allPackages
7976
],
8077
'[tex]/all-packages': allPackages
81-
}
78+
};
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
import './lib/amsCd.js';

components/src/input/tex/extensions/ams_cd/amscd.js

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"component": "input/tex/extensions/amscd",
2+
"component": "input/tex/extensions/amsCd",
33
"targets": ["input/tex/ams_cd"]
44
}
55

components/src/input/tex/extensions/ams_cd/webpack.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
const PACKAGE = require('../../../../../webpack.common.js');
22

33
module.exports = PACKAGE(
4-
'input/tex/extensions/amscd', // the package to build
4+
'input/tex/extensions/amsCd', // the package to build
55
'../../../../../../js', // location of the MathJax js library
66
[ // packages to link to
77
'components/src/input/tex-base/lib',

0 commit comments

Comments
 (0)