Atom Packages Directory

a package directory for a text editor of the 21st Century

Markdown Preview Enhanced

Install with:
    apm install markdown-preview-enhanced
  

Markdown Preview Enhanced

Still Beta Version!

中文文档
Wiki (not done yet)


Version 0.10.9 supports prince pdf export.
More information can be found at this doc.


language-gfm-enhanced is recommended to be installed to work with markdown-preview-enhanced.

Post here if you request new features or you want to report bugs ;)

(TOC below was generated by this package Markdown Preview Enhanced: Create Toc)


intro

Features

How it works

Usages

To use this package, press cmd + shift + p in atom editor first to toggle Command Palette . Then choose the commands below: - Markdown Preview Enhanced: Toggle - Toggle Markdown file preview with KaTeX support.
You can also use the keymap ctrl+shift+m to toggle preview. (To use keymap, you have to disable the default markdown preview package, otherwise there would be keymap conflict) - Markdown Preview Enhanced: Toggle Zen Mode
- Toggle distraction free writing.
- Markdown Preview Enhanced: Customize CSS - Customize preview page css. You can edit styles inside markdown-preview-enhanced-custom section in style.less file.
- If you didn’t see markdown-preview-enhanced-custom section in style.less file, you may need to run Markdown Preview Enhanced: Customize CSS command first. - Markdown Preview Enhanced: Create Toc - Generate TOC (need preview toggled). doc is here.
- Markdown Preview Enhanced: Toggle Scroll Sync - Enable/Disable scroll sync for preview. - Markdown Preview Enhanced: Toggle Live Update - Enable/Disable live update for preview. - If disabled, preview will only be rendered when the file is saved.
- Markdown Preview Enhanced: Toggle Break On Single Newline - Enable/Disable breaking on single newline. - Markdown Preview Enhanced: Insert New Slide
- Markdown Preview Enhanced: Insert Table - Markdown Preview Enhanced: Insert Page Break - Markdown Preview Enhanced: Config Mermaid - Edit mermaid init configuration. - Markdown Preview Enhanced: Config Header Footer - PDF export header and footer configuration. - Markdown Preview Enhanced: Image Helper
- Image Helper supports image url quick insertion, image paste, and image upload powered by imgur and sm.ms.
(if imgur is blocked by the Great Firewall, then you can choose sm.ms instead).
- Keymap ctrl+shift+i
- image_helper

Preview Context Menu

Right click at preview to see the menu

contextmenu

Extra

For Developer

Manual installation instruction can be found here.
It is also very easy to write your own extension, more information can be found here.

FAQ

  1. I am not able to find this package in atom?
    Please search for the full name of this package. markdown-preview-enhanced
  2. I exported a html file, and I want to deploy it on my own remote server. But math typesetting (MathJax or KaTeX) doesn’t work, what should I do?
    Please make sure you have Use CDN hosted resources checked when exporting.
  3. I exported a presentation html file, and I want to put it on my Github Page or deploy remotely?
    Please check the last question.
  4. How do I get dark style preview?
    If you want the style of the preview to be consistent with your atom editor, go to settings of this package, then change the Preview Theme.
    Or you can run Markdown Preview Enhanced: Customize Css command, then modify the style.less file. #68, #89.
  5. The preview is super super lagging?
    This might happen when your markdown file is too big, or you are using too many math or graphs.
    Therefore I would like to recommend you to disable Live Update functionality.
    You can run Markdown Preview Enhanced: Toggle Live Update to disable it.
  6. Do you need a job? (Huh… is this question really related to FAQ???)
    Yes, I am looking for job. (*/ω\*) (Any country (region) should be fine for me. I can also work remotely.)
    I am an international student from China currently studying at University of Illinois at Urbana-Champaign. I am a CS major student and I will get my BS/MCS degree this May (2017).
    I am personally very interested in game development and front-end web development. If you are willing to offer me a job opportunity, please contact me by my school email ywang189@illinois.edu or my personal email shd101wyy@(sina|gmail).com. (plz don’t be mad if you don’t get any response from me because I might be busy working on my homework `(✿◡‿◡)).
    Thank you very much :)

Credits

Thanks

Thanks for using and supporting this package ;)

University of Illinois/NCSA Open Source License

Keywords: markdown, presentation, image helper, katex, mathjax, mermaid, plantuml, wavedrom, pdf, html, exporter, phantomjs, toc, footer, graphviz, dot language, epub, ebook, pandoc, beamer, latex Suggest keywords
Fork me on GitHub