https://github.com/mathpix/vscode-mathpix-markdown

Enable rendering Mathpix Markdown with latex and chemistry support.
https://github.com/mathpix/vscode-mathpix-markdown

chemistry extension latex markdown vscode

Last synced: 3 days ago
JSON representation

Enable rendering Mathpix Markdown with latex and chemistry support.

• Host: GitHub
• URL: https://github.com/mathpix/vscode-mathpix-markdown
• Owner: Mathpix
• License: mit
• Created: 2020-11-11T09:40:54.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-18T17:54:10.000Z (about 2 months ago)
• Last Synced: 2024-11-18T18:48:50.559Z (about 2 months ago)
• Topics: chemistry, extension, latex, markdown, vscode
• Language: JavaScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=mathpix.vscode-mathpix-markdown
• Size: 887 KB
• Stars: 29
• Watchers: 12
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VSCode Mathpix Markdown Extension

![](./images/screenshot.png)

## Features 

- Enables enhanced markdown syntax to be rendered in markdown previews

- Enables a subset of LaTeX commands to be rendered in markdown previews

- Enables SMILES chemistry syntax to be rendered in markdown previews

## Extension Installation

The extension can be installed in several ways:

### From extensions search (`ctrl-shift-x` or `cmd-shift-x`):

Enter `@id:mathpix.vscode-mathpix-markdown`

### From quick open (`ctrl-p` or `cmd-p`):

`ext install @id:mathpix.vscode-mathpix-markdown`

### From CLI:

`code --install-extension mathpix.vscode-mathpix-markdown`

## Mathpix Markdown Usage

Once installed the extension adds supports for all the features of mathpix-markdown such as latex, chemistry and html rendering in the built-in VSCode markdown preview.

To use it open a markdown or mathpix markdown file (with `.md` or `.mmd` extensions) then open the command pallete (`f1` key) and select `Markdown: Open Preview` or `Markdown: Open Preview to the Side`.

Further Documentation:

- [Overview](https://mathpix.com/docs/mathpix-markdown/overview)

- [Syntax Reference](https://mathpix.com/docs/mathpix-markdown/syntax-reference)

## Local Development

You can develop, build and install the extension locally.

```

git clone [email protected]:Mathpix/vscode-mathpix-markdown.git

cd vscode-mathpix-markdown

npm install

vsce package

```

Then in VSCODE:

```

type f1

extensions: Install from VSIX

choose the file vscode-mathpix-markdown-0.0.1.vsix

click reload

open SYNTAX.md

type f1

Markdown: Open Preview to the Side

```