https://github.com/yousefvand/mathover

A vscode extension to preview math formulas in comments.
https://github.com/yousefvand/mathover

comments hover latex math mathematics mathml vscode-extension

Last synced: 4 months ago
JSON representation

A vscode extension to preview math formulas in comments.

• Host: GitHub
• URL: https://github.com/yousefvand/mathover
• Owner: yousefvand
• License: mit
• Created: 2020-09-05T14:19:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-20T10:58:39.000Z (11 months ago)
• Last Synced: 2024-10-24T06:30:01.152Z (4 months ago)
• Topics: comments, hover, latex, math, mathematics, mathml, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 726 KB
• Stars: 16
• Watchers: 2
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mathover

[![Release](https://img.shields.io/github/release/yousefvand/mathover/all.svg)](https://github.com/yousefvand/mathover/releases) [![GitHub issues](https://img.shields.io/github/issues/yousefvand/mathover)](https://github.com/yousefvand/mathover/issues) [![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/yousefvand/mathover.svg)](http://isitmaintained.com/project/yousefvand/mathover "Average time to resolve an issue") [![GitHub forks](https://img.shields.io/github/forks/yousefvand/mathover)](https://github.com/yousefvand/mathover/network) [![GitHub stars](https://img.shields.io/github/stars/yousefvand/mathover)](https://github.com/yousefvand/mathover/stargazers) [![GitHub license](https://img.shields.io/github/license/yousefvand/mathover)](https://github.com/yousefvand/mathover/blob/master/LICENSE)

A [vscode](https://code.visualstudio.com/) extension to preview math formulas in comments.

- Works in any document (default: configured for Python).

- Supports Latex, MathML in either inline or display mode (default: display).

- Works offline.

- Caches images.

- Highly configurable.

## How to use

Define a trigger pattern as `regex` by setting `matchRegex` and `matchRegexFlags` in extension configurations.

Default pattern looks for `# Math: ` and interprets whatever after it as **math** to the end of the line.

![Demo](images/demo.gif)

## Installing from source

You need to have [git](https://git-scm.com/) and [node.js](https://nodejs.org/) installed. Go to your vscode extension path:

- Windows `%USERPROFILE%\.vscode\extensions`

- macOS `~/.vscode/extensions`

- Linux `~/.vscode/extensions` (OSS: `~/.vscode-oss/extensions`)

Make sure extension is not already there (`remisa.mathover-{version}`). Close vscode before running following commands:

```bash

# Assuming current path is: ~/.vscode/extensions

git clone https://github.com/yousefvand/mathover.git

cd mathover

npm i

npm run compile

```

Open vscode and extension is installed (see [#1](https://github.com/yousefvand/mathover/issues/1)).

### [Change History](CHANGELOG.md)