Light

yousefvand / mathover Goto Github PK

View Code? Open in Web Editor NEW

13.0 2.0 4.0 743 KB

A vscode extension to preview math formulas in comments.

License: MIT License

JavaScript 6.14% Shell 6.81% TypeScript 87.05%

vscode-extension mathematics math latex mathml comments hover

mathover's Introduction

Mathover

A vscode 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.

Installing from source

You need to have git and node.js 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:

# 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).

Change History

mathover's People

Contributors

Stargazers

Watchers

Forkers

heartacker sankoudai mirrorazure milkmilks

mathover's Issues

Publishing on OpenVSX Marketplace

It would be nice to have this extension available in the VSCodium Marketplace OpenVSX which

is a vendor-neutral open-source alternative to the Visual Studio Marketplace.

The manual on how to publish can be found in their GitHub repo.

Thank you for consideration 😊

TeX parse error: Undefined control sequence \argmax

Thanks for making this extension!

When I use it, it cannot parse \argmax which IMO is common usage.
Is this a MathJax-node problem, or does it need configurations?
How can I get this fixed?

Is it possible to have this render in-line instead of on hover?

Bundle extension

I managed to bundle my own transpiled typescript code into one js file (using rollup) but failed to bundle dependencies from node_modules. The published version on vscode marketplace simply contains node_modules from npm i --production without bundling and tree shaking.

If you know how to do that, PRs are welcome.

Katex Markdown

I am curious to know if anyone has used this extension for katex in markdown, and if they have a working regex expression they could share. I have tried a few, but haven't had any success. Thanks.

Can you add this to the vscode chatGPT extension?

This isn't a bug. You can close it. I added a feature request to add mathML display to the answers coming from chatGPT through a vscode extension. I see you already did this with mathover. Maybe it's simple for you. Here's the feature request. ai-genie/chatgpt-vscode#49

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.