Giter VIP home page Giter VIP logo

vscode-instant-markdown's Introduction

vscode-instant-markdown

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

screencast

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

This extension is build on 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

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

MIT © David Bankier @dbankier @davidbankier

vscode-instant-markdown's People

Contributors

alallier avatar dbankier avatar girish-jha avatar oscarvazquez avatar rasa avatar soulchild avatar woobs avatar

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

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

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.