Skip to content

Fix: added build steps to readme and removed ios warning #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,20 @@ git submodule init

git submodule update

npm install
# Setup, make a dev build and start a server
npm start
```

If you get an
```bash
Error: MDX compilation failed for file "X:\PATHTO\cortexjs.io\docs\mathfield\22-security.md"
Cause: Cannot read properties of null (reading '1')
Details:
TypeError: Cannot read properties of null (reading '1')
```
Then go through each of the .md files and save them (CTRL+S) so you are sure the contents is saved to disk. You should be able to build successfully.

## To update the documentation after a new release

```bash
Expand Down
8 changes: 0 additions & 8 deletions docs/mathfield/11-interacting.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,16 +227,8 @@ to be dispatched.
| `deleteContentForward`| |
| `historyUndo`| The content was changed because of an undo command |
| `historyRedo`| The content was changed because of a redo command |


</div>

:::warning

On iOS, the `inputType` property is removed. However, its content can also be access as `ev.data`. Until this issue is addressed in iOS, for better compatibility, use `ev.data`.

:::

The `beforeinput` event is dispatched before any modifications to the mathfield
have been done. This event is cancelable. Calling `preventDefault()` on the
event will cause the modification to be prevented.
Expand Down
2 changes: 1 addition & 1 deletion docs/mathfield/12-customizing.md
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,4 @@ MathfieldElement.fontsDirectory = "https://unpkg.com/mathlive/dist/fonts/";
<math-field>
x=\frac{-b\pm \sqrt{b^2-4ac}}{2a}
</math-field>
```
```