Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dbankier/vscode-instant-markdown

vscode extension for instant markdown previews
https://github.com/dbankier/vscode-instant-markdown

Last synced: about 2 months ago
JSON representation

vscode extension for instant markdown previews

Host: GitHub
URL: https://github.com/dbankier/vscode-instant-markdown
Owner: dbankier
Created: 2015-12-02T01:33:15.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2022-12-10T16:29:48.000Z (about 2 years ago)
Last Synced: 2024-04-09T18:02:56.734Z (9 months ago)
Language: TypeScript
Size: 2.74 MB
Stars: 53
Watchers: 6
Forks: 24
Open Issues: 20
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# vscode-instant-markdown

> Simply, edit markdown documents in vscode and instantly preview it in your browser.

![screencast](./vscode-instant-markdown.gif)

**Note** Version 1.0 is a complete rewrite and no longer works using instant-markdown-d.

This extension is build on [markdown-it](https://github.com/markdown-it/markdown-it) and uses the following extensions:

* markdown-it-mathjax
* markdown-it-named-headers
* markdown-it-plantuml
* markdown-it-sup
* markdown-it-task-lists

## Installation

Press F1 and narrow down the list commands by typing `extension`. Pick `Extensions: Install Extension`.
Select the `Instant Markdown` extension from the list

## Install Manual

**Mac & Linux**
```sh
cd $HOME/.vscode/extensions
git clone https://github.com/dbankier/vscode-instant-markdown.git
cd vscode-instant-markdown
npm install
```

**Windows**
```
cd %USERPROFILE%\.vscode\extensions
git clone https://github.com/dbankier/vscode-instant-markdown.git
cd vscode-instant-markdown
npm install
```

## Usage

When you edit a markdown document it should instantly preview in your browser with changes applied as you type.

You browser should automatically open to `http://localhost:8090`

### Configuration

You can turn off the automatic opening of the browser. Just change the default configuration of `instantmarkdown.autoOpenBrowser` from `true` to `false`.

You can then use `> Instant Markdown: Open Browser` to open the broswer or create a shortcut for the following command `instantmarkdown.openBrowser`.

You can turn off the automatic closing of the browser. Just change the default configuration of `instantmarkdown.autoCloseServerAndBrowser` from `true` to `false`.

You can also change the `host` and `port` that the server runs on by changing their respective default settings.

Finally you can increase the `debounce` value from `0` milliseconds to make the plugin less instant.

## License