https://github.com/pixelastic/markdown-preview
Renders a preview of a markdown text in your browser.
https://github.com/pixelastic/markdown-preview
Last synced: 4 months ago
JSON representation
Renders a preview of a markdown text in your browser.
- Host: GitHub
- URL: https://github.com/pixelastic/markdown-preview
- Owner: pixelastic
- Created: 2017-11-03T14:26:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-03T17:27:09.000Z (over 8 years ago)
- Last Synced: 2025-02-17T15:52:29.292Z (over 1 year ago)
- Language: HTML
- Homepage:
- Size: 43 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# markdown-preview
Renders a preview of a markdown text in your browser.
## Usage
```sh
$ markdown-preview ./readme.md
```
## Installation
Install globally with `yarn global add @pixelastic/markdown-preview`
## Integration with vim
I've added the following mapping to my `after/ftplugin/markdown.vim` to see
a preview when I press `F5`.
```vim
nnoremap :call MarkdownPreview()
function! MarkdownPreview()
silent execute ':!nohup markdown-preview % &>/dev/null &'
redraw!
endfunction
```
## Limitations
- Uses a hard-coded `/tmp/` to store the HTML file
- Uses a hard-coded `google-chrome` to open the file
- Does not handle local images