# @ibrahima/remark-math

> Math Inline and Block parser plugin for Remark

Latest version **1.1.0-alpha.2** (published 2018-06-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ibrahima/remark-math
pnpm add @ibrahima/remark-math
yarn add @ibrahima/remark-math
bun add @ibrahima/remark-math
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.0-alpha.2 |
| Published | 2018-06-20 |
| First published | 2018-06-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Junyoung Choi |
| Maintainers | ibrahima |
| Keywords | markdown, remark, math, katex, latex, tex |

## Links

- npm: https://www.npmjs.com/package/@ibrahima/remark-math
- Repository: https://github.com/ibrahima/remark-math
- Homepage: https://github.com/Rokt33r/remark-math#readme
- Issues: https://github.com/Rokt33r/remark-math/issues
- npm.io page: https://npm.io/package/@ibrahima/remark-math

## Dependencies (1)

- [trim-trailing-lines](https://npm.io/package/trim-trailing-lines.md) ^1.1.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.1.0-alpha.2 (latest) — 2018-06-20
- 1.1.0-alpha1 — 2018-06-20
- 1.0.4 — 2018-06-20

## README

# Gradescope's Remark Math Fork

Math Inline and Block supporting for Remark

This is a customized fork of [remark-math](https://github.com/remarkjs/remark-math)

This project contains three packages:
- remark-math
- rehype-katex
- remark-html-katex

Gradescope's fork contains enhancements to the `remark-math` package.


## What does Remark Math?

`remark-math` is designed to parse `$` and `$$` delimited text as
`inlineMath` and \[display/block\] `math` nodes, respectively.

The Gradescope fork is designed to enable more flexible delimiters.
Specifically, for our use case, we want to recognize `$$` to delimit
`inlineMath`, and `$$$` to delimit \[display/block\] `math`.

In order to support custom delimiters, `remark-math` now accepts a
`modes` option. An example for usage can be found in `./specs/remark-math.spec.js`.


### Developing and Building

To build and test the `remark-math` package, run:

```bash
$ nvm use
$ npm install
$ cd ./packages/remark-math
$ npm run-script build
$ cd ../..
$ npm run-script test:api
```


### Publishing

To build and publish the Remark-Math package to Turnitin's Artifactory repository,
run:

```bash
$ nvm use
$ npm install
$ npm run-script tii-publish-remark-math
```

## Future Plans

We hope to reapply these features to the latest version of `remark-math`,
and to submit them for merging into the upstream.
However, that may take significantly rewriting these features.


## More Info

For more information on the original project, see
[the upstream project's original README](./readme-upstream.md).

---
_Source: https://npm.io/package/@ibrahima/remark-math · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._