diff --git a/README.md b/README.md index 03d2391..be61bf0 100644 --- a/README.md +++ b/README.md @@ -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).