Since different Markdown implementation will output differetn HTML sometimes, I make this package to let people preview the articles on GitHub Pages on Atom. It is modified from Markdown Preview
Show the rendered HTML markdown to the right of the current editor using ctrl-shift-m.
It is currently enabled for
You need to install kramdown library first. Follow the instruction, http://kramdown.gettalong.org/installation.html.
This package uses node package
highlights which uses
oniguruma is a native binding library and needs to be built when installing. You need to install Python 2.7, gcc, make tools.
xcode-select --installto install xcode command line tools.
On Windows:and you do not need to manually install global
node-gypnode package since Atom should have this. In the guide, there are two options, and option1 is my suggested way (But it needs to install your own node/npm first).
Install this atom package.
(Optional) You may disable the default built-in Markdown-Preview to avoid confusion on shortcuts. They use the same shortcuts and this package will override those in Markdown-Preview.
Tested Atom version: 1.15.0. 1.23.3 Tested platforms:
Besides the normal procedure (create a symbolic link of the git folder in ~/.atom/dev/packages), the important thing is that this package relies on some native binding library. So if you use your own
node+npm to run
npm install, it may result in some conflict with Atom's node. So please use Atom's built-in
node+npm to install the node dependencies. Steps:
running Update Package Dependencies: Update in Atom, ref: http://stackoverflow.com/questions/36810276/installing-package-dependencies-in-atom.
GitHub Pages and some/all markdown files on GitHub can accept these two types and show correctly. But this atom package only handles Kramdown type(~~~). Please keep in mind, and my opinion is to use ~~~. Also They both support non-fenced standard code block (indented 4 spaces) and single line code span.
According https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0, Starting May 1st, 2016, GitHub Pages will only support kramdown, Jekyll's default Markdown engine.
Markdown Preview Kramdown is released under the MIT license.
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.