Giter Club home page Giter Club logo

markdown-preview's Introduction

Markdown Preview Plus

Automatically parses markdown files (.md) into HTML. This is useful if you're writing markdown (ultimately targeting HTML) and want a quick preview.

Get it for Chrome

Features

  1. Support auto reload.
  2. Support external css file.
  3. Customize theme for every md file.
  4. Support github flavored markdown.
  5. Export nicely formatted HTML.
  6. Support KaTex.

Usage

  1. Install extension from webstore (creates no new UI)
  2. Check "Allow access to file URLs" in chrome://extensions listing: fileurls
  3. Open local or remote .md file in Chrome.
  4. See nicely formatted HTML!

Math Syntax

Markdown Preview Plus uses the KaTex engine to support rendering of mathematical expressions. Markdown Preview Plus supports the following math syntax. To minimize interference between Markdown and KaTex, some standard LaTeX delimiters (indicated below) are disabled by default to avoid conflict with Markdown syntax. LaTeX syntax can be enabled in the options.

Inline Math

  • Single Dollar Signs (requires LaTeX delimiters): $math$. When LaTeX syntax is enabled, dollar signs used in non-math contexts should be escaped with a backslash: \$

  • Single Backslash with Parentheses (requires LaTex delimiters): \(math\). Conflicts with Markdown's escaped syntax for parentheses \(.

  • Double Backslash with Parentheses: \\(math\\)

Display Math

  • Single Backslash with Brackets (requires LaTeX delimiters): \[math\]. Conflicts with Markdown's escaped syntax for brackets \[.

  • Double Backslash with Brackets: \\[math\\]

  • Double Dollar Signs: $$math$$

Thanks

Thanks to Kevin Burke for his markdown-friendly stylesheet, to chjj for his JavaScript markdown processor, to Boris Smus for his Markdown Preview and to Swartz and Gruber for Markdown.

Links

markdown-preview's People

Contributors

volca avatar zgce avatar ktchu avatar ivorson avatar ggrossetie avatar haimoz avatar chaserhkj avatar aprbrother avatar josemotanet avatar lukas238 avatar mathiasbynens avatar hyrious avatar ozmium avatar

Watchers

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