Giter Club home page Giter Club logo

markdownpreview's Introduction

Unix Build Status Package Control Downloads License

Markdown Preview

Preview and build your markdown files quickly in your web browser using Sublime Text 3.

You can use the builtin Python Markdown parser (offline) or use the GitHub Markdown API or GitLab Markdown API (online) for the conversion.

Features

  • Markdown preview using the python-markdown with syntax highlighting via Pygments and optional 3rd party extensions (pymdown-extensions included by default).
  • Markdown previews via the GitHub API.
  • Markdown previews via the GitLab API thanks to @hadisfr.
  • Ability use other external Markdown parsers.
  • Build markdown file using Sublime Text build system.
  • Browser preview auto reload on save if you have the LiveReload plugin installed.
  • Configurable CSS and JavaScript assets with overriding if needed.
  • YAML support thanks to @tommi.
  • Clipboard selection and copy to clipboard thanks to @hexatrope.
  • MathJax support : \(\frac{\pi}{2}\) thanks to @bps10.
  • HTML template customization thanks to @hozaka.
  • Embed images as base64.
  • Strip out MultiMarkdown CriticMarkup.

Documentation

https://facelessuser.github.io/MarkdownPreview/

Support

  • Any bugs about Markdown Preview please feel free to report here.
  • And you are welcome to fork and submit pull requests.

Attribution

Markdown Preview contains a stripped down version of font awesome that is included in the default non-GitHub CSS. It contains only the icons we currently use.

https://fontawesome.com/license

License

The code is available at GitHub under the MIT license.

markdownpreview's People

Contributors

facelessuser avatar revolunet avatar hadisfr avatar xpol avatar stummjr avatar int3h avatar reyronald avatar bps10 avatar qrohlf avatar chronossc avatar jnraine avatar hoffmannp avatar sdefresne avatar tommi avatar adoussot avatar sauerbraten avatar adamralph avatar duncanhills avatar albertcthomas avatar alch avatar cowboy avatar christiansiegert avatar christianvuerings avatar curtisgibby avatar danmactough avatar edvandance avatar edwardball avatar phette23 avatar evanpurkhiser avatar gkampolis avatar

Watchers

James Cloos 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.