Skip to content

facelessuser/MarkdownPreview

This branch is 180 commits ahead of, 4 commits behind revolunet/sublimetext-markdown-preview:master.

Folders and files

NameName
Last commit message
Last commit date
Jan 14, 2024
Mar 27, 2024
Jan 14, 2024
May 24, 2022
May 23, 2022
May 24, 2022
Jul 27, 2018
Nov 30, 2019
Nov 9, 2019
Apr 12, 2018
Jan 14, 2024
Sep 23, 2024
Sep 24, 2024
Jan 14, 2024
Sep 24, 2024
Feb 16, 2014
Jan 30, 2025
May 24, 2022
Aug 12, 2022
Jun 3, 2017
Jan 16, 2024
Dec 31, 2018
May 23, 2022
May 24, 2022
Jan 14, 2024
Mar 4, 2021

Repository files navigation

Build Package Control Downloads License

Markdown Preview

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

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}\).
  • 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 under the MIT license.