Skip to content

docs: improve README for community use and contrib #1

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.

Sign up for GitHub

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

Draft
tomymaritano wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: improve README for community use and contrib #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 37 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,47 @@
# Math

Official [Dripnex](https://dripnex.app) plugin. Inserts a `$$` display-math fence.
Official [Dripnex](https://dripnex.app) plugin. Inserts a `$$` display-math fence at the cursor.

KaTeX preview ships with the desktop (`dripnex-math`). This repo is the installable community surface.

## What it does

Adds **Insert Math Block** (command `math:insert`) to insert this LaTeX fence at the cursor:

```
$$
E = mc^2
$$
```

KaTeX rendering ships with Dripnex. This plugin only inserts the fence.

Plugin id: `math` (v0.1.0). Entry: `dist/index.js`.

## Install

```
dripnex/plugin-math
```

## Develop

Source is CommonJS in `src/index.js`. The packed entry is `dist/index.js`.

```bash
npm run build # copy src/index.js → dist/index.js
npm run pack # dripnex-plugin pack .
```

`pack` requires the `dripnex-plugin` CLI.

## Contribute

Issues and pull requests are welcome.

1. Fork and clone this repo.
2. Edit `src/` (keep CommonJS).
3. Run `npm run build`.
4. Open a focused pull request.

MIT — see [LICENSE](LICENSE).