# Markdown+Math

• ## What is it ...

mdmath allows to use Visual Studio Code as a markdown editor capable of typesetting and rendering TeX math. In fact it now reuses the built in markdown viewer. KaTeX works inside as a fast math renderer.

You can install the extension directly from Visual Studio Code Marketplace.

## Features

Simplify the process of authoring and live previewing markdown documents containing math formulas. This extension is a comfortable tool for scientists, engineers and students with markdown as their first choice document format.

• Inline math
• Display math
• Formula numbering
• Inline math with tables
• Export resulting HTML code for web usage

### What is new in mdmath 2.0 ...

• Integrated in native markdown viewer. So after installing the extension, TeX math is properly displayed in the markdown preview window.
• Based on markdown-it plugin markdown-it-texmath.
• Using vscode's Markdown Extension API.
• Editor view and Preview are synchronized while scrolling.
• Heavily reduced code size.
• Works offline.
• Due to markdown-it-texmath's support of different formula delimiters, these are also available and user configurable with mdmath:
• dollars (default)
• inline $...$
• display $$...$$
• brackets
• inline $$...$$
• display $...$
• gitlab
• inline $...$
• display math ... 

## Installation ...

### ... from inside of VSCode

Press F1 key inside of Visual Studio Code and type extension. Choose Extensions: Install Extension and then select the Markdown+Math extension from the list.

cd $HOME/.vscode/extensions git clone https://github.com/goessner/mdmath.git cd mdmath npm install  ### ... from Windows Command Line cd %USERPROFILE%\.vscode\extensions git clone https://github.com/goessner/mdmath.git cd mdmath npm install  ## Usage • Launch VS Code, create or open a markdown file (.md). • Open a preview window. • Typeset in your markdown source window and see the preview window live updating. • Press Ctrl+K . or run the command Clip Markdown+Math to HTML to copy the corresponding HTML source to the underlying systems clipboard. ## Default User Settings  // Path to custom stylesheet file (css). "mdmath.delimiters": "dollars"  ## Dependencies ## FAQ • Formula highlighting is broken ? • Math formula highlighting is experimental. • It is implemented only for $ delimiters at present.
• $ characters in markdown text are sometimes confused with math delimiters. Enclose them by backticks () then. • Formula highlighting is possible only for formulas on a single line. It breaks with every newline character. • Math highlighting is completely different from LaTeX math parsing. • Which functions does KaTeX support ? • What if I need to use the currency symbol $ also in my markup ?
• It should be safe to use it. If in doubt escape it.
• What are the restrictions with inline formulas ?
• Whitespace after opening $ and before closing $ is not allowed.
• Numeric character before opening $ and after closing $ is not allowed.
• At least one character (whitespace ?) is required between two consecutive inline formulas.
• Line break inside is not allowed.
• What are the restrictions with display formulas ?
• Not allowed inline of text.
• Blank lines before and behind required.
• Restrictions for inline formulas do not apply.
• Can I use math markup in blockquotes ?
• We can use inline and display formulas in blockquote sections. In order to avoid the blockquote symbol '>' being part of a multiline display formula, display formulas have to be written on a single line in blockquote sections.
• Can I use math markup in code blocks ?
• No, math markup in code blocks is shown - as expected - as markup. This is consistent now, but in contrast to mdmath versions prior to 2.0.
• Can I access the HTML source of the markdown file ?
• Yes. Use the Markdown: Clip Markdown+Math to Html command or the key binding ('ctrl+K .').
• The markdown preview window has to be opened once for this in order to function properly.
• You need to have the markdown source window activated here (not the preview window!).
• Please note, that the resulting HTML source references 'CDN'-located remote css files. Change those references to local URL's if necessary.
• Is PDF output supported ?
• Not directly. In order to create *.pdf output from your Markdown you can create a *.html document first and print it then using a PDF printer or use Pandoc.
• See Compiling Markdown into HTML.
• Can I use custom CSS styles for the preview window ?
• Yes. Set mdmath.style in user settings to the location of your custom CSS file. Its path must be relative to this extension root.
• Cannot copy to clipboard on Linux ?
• This may be because the upstream clipboardy needs xsel on Linux. Run sudo apt-get install xsel` to install.

01-30 2万+

09-03 6455
07-25 2万+
05-21
05-29
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客