Skip to content

Commit

Permalink
Update links to README files to just be to the directories (so the fi…
Browse files Browse the repository at this point in the history
…le list is visible).
  • Loading branch information
dpvc committed May 20, 2019
1 parent 57586a5 commit 8f6c29c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [mj3-demos](https://github.com/mathjax/mj3-demos)
# [mj3-demos-node](https://github.com/mathjax/mj3-demos-node)

A repository with examples using [mathjax-v3](https://github.com/mathjax/mathjax-v3).

Expand Down Expand Up @@ -38,11 +38,11 @@ The first four convert an expression from a TeX or MathML string (its first argu

Use the `--help` option to get a list of all the possible options for each command.

The three categories of commands are stored in the directories called [component](component/README.md), [preload](preload/README.md), and [direct](direct/README.md). See those directories for additional information about the example files they contain.
The three categories of commands are stored in the directories called [component](component), [preload](preload), and [direct](direct). See those directories for additional information about the example files they contain.

There are also a directory [speech](speech/README.md) that give examples of converters that add speech strings to their results, which illustrate more sophisticated operations in MathJax. This is described in more detail in that directory.
There are also a directory [speech](speech) that give examples of converters that add speech strings to their results, which illustrate more sophisticated operations in MathJax. This is described in more detail in that directory.

Finally, the [custom-tex-extension](custom-tex-extension/README.md) directory contains an example of how to create your own custom TeX extension and load it as a component. Again, see the directory for more details.
Finally, the [custom-tex-extension](custom-tex-extension) directory contains an example of how to create your own custom TeX extension and load it as a component. Again, see the directory for more details.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion component/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Component-Based Examples

The examples in this directory illustrate how to use MathJax v3 components in your NodeJS projects. Loading of components in asynchronous, and so you may need to use promises to mediate the flow of your program, particular program startup. Once MathJax's components are loaded, however, you can call the non-promise-based functions, but should use the promise-based ones if you want to support autoloading of extensions or the `\require` macro in TeX input. (Note that the [preload](../preload/README.md) examples show how to operate synchronously from the outset, if that is required.)
The examples in this directory illustrate how to use MathJax v3 components in your NodeJS projects. Loading of components in asynchronous, and so you may need to use promises to mediate the flow of your program, particular program startup. Once MathJax's components are loaded, however, you can call the non-promise-based functions, but should use the promise-based ones if you want to support autoloading of extensions or the `\require` macro in TeX input. (Note that the [preload](../preload) examples show how to operate synchronously from the outset, if that is required.)

All the examples in this directory consist of three main parts:

Expand Down
4 changes: 2 additions & 2 deletions speech/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The main steps needed for this are to:
2. Configure extension to generate deep or shallow speech strings, and
3. Add a custom `renderAction` to the math document that removes all non-speech attributes added by the enrichment process.

Most of the examples in this directory use the MathJax [components approach](../component/README.md) to accomplish this, but the `mml2svg` example uses the [direct approach](../direct/README.md) in order to illustrate that as well.
Most of the examples in this directory use the MathJax [components approach](../component) to accomplish this, but the `mml2svg` example uses the [direct approach](../direct) in order to illustrate that as well.

## Component-Base Example

Expand All @@ -35,7 +35,7 @@ The rest of the file is the same as the standard `tex2chtml` using components.

## Direct-Import Example

The [`mml2svg`](mml2svg) example uses the [direct import](../direct/README.md) approach. The key additions in this case are
The [`mml2svg`](mml2svg) example uses the [direct import](../direct) approach. The key additions in this case are

```
const EnrichHandler = require('mathjax3/mathjax3/a11y/semantic-enrich.js').EnrichHandler;
Expand Down

0 comments on commit 8f6c29c

Please sign in to comment.