Skip to content

Commit

Permalink
release 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
goessner committed Dec 20, 2016
1 parent ef7773f commit d7b2f55
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,18 @@
[![npm](https://img.shields.io/npm/v/mdmath.svg)](https://www.npmjs.com/package/mdmath)
[![npm](https://img.shields.io/npm/dt/mdmath.svg)](https://www.npmjs.com/package/mdmath)

## What is it ...

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

You can install the extension directly from [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=goessner.mdmath).

Release 1.0 published with support of ...

* Formula numbers.
* Footnotes

![mdmath editing](img/edit.gif)

## Features
Expand All @@ -25,6 +31,10 @@ document format.
* Syntax highlighting with code sections
* Export resulting HTML code for web usage

## Test Table

Some math expressions are collected in a [test table](http://goessner.github.io/mdmath/test/).

## Installation ...

### ... from inside of VSCode
Expand Down Expand Up @@ -61,6 +71,8 @@ npm install

>*Note*: Attempt to show HTML output with *Preview Window* as *Active Window* results in a warning `Cannot show source of that document!`. Make your markdown source window *active* first.
You can see HTML export of `triangle.md` live in [your browser](http://goessner.github.io/mdmath/triangle.html).


## Dependencies

Expand All @@ -86,8 +98,9 @@ See [contributing.md](contributing.md)
* Very simple (manual) equation numbering implemented.
* KaTeX error highlighting activated.
* Footnotes by `markdown-it-footnote` added.
* Standalone tests for math rendering added.
* Standalone [tests](http://goessner.github.io/mdmath/test/) for math rendering added.
* Markdown+Math CSS file added to [CDN](https://gitcdn.xyz/repo/goessner/mdmath/master/css/mdmath.css)
* Some minor bugs removed.

* December 2, 2016
* Release 0.9.0
Expand Down
Binary file modified img/htmlExport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"displayName": "Markdown+Math",
"description": "LaTeX Math for Markdown",
"icon": "img/icon.png",
"version": "0.9.8",
"version": "1.0.0",
"author": "Stefan Goessner",
"publisher": "goessner",
"galleryBanner": {
Expand Down

0 comments on commit d7b2f55

Please sign in to comment.