📝 Real-time Markdown Editor & Previewer for VS Code
MIT License
Markdown-live supports the followings
markdown/.md
document with its content..md
filesmarkdown/.md
file, click on the icon to toggle the side-barCommand | Description |
---|---|
showMarkdown |
Toggle Markdown panel |
toggleScrollSync |
Toggle Scroll Sync Mode |
Name | Description | Default value |
---|---|---|
automaticallyShowPreviewOfMarkdown |
Automatically shows preview once the markdown/.md file gets opened up | true(boolean) |
syncScroll |
Automatically sync the scroll of both editor and doc | true(booelan) |
display2X |
Display toolbar buttons of the editor at 2X size | false(boolean) |
convertPastedImages |
Convert pasted images to local files, if not it will show in base64 format | true(boolean) |
mediaFolder |
The folder where images are saved relative to the markdown file project folder | .media(string) |
File -> Preferrences -> settings
Shortcuts | Functionality |
---|---|
ctrl + alt + 1/cmd + alt + 1 | Heading 1 |
ctrl + alt + 2/cmd + alt + 2 | Heading 2 |
ctrl + alt + 3/cmd + alt + 3 | Heading 3 |
ctrl + alt + 4/cmd + alt + 4 | Heading 4 |
ctrl + alt + 5/cmd + alt + 5 | Heading 5 |
ctrl + alt + 6/cmd + alt + 6 | Heading 6 |
ctrl + alt + 0/cmd + alt + 0 | Normal |
ctrl + alt + b/cmd + alt + b | Bold |
ctrl + alt + i/cmd + alt + i | Italic |
ctrl + alt + r/cmd + alt + r | Strike |
ctrl + alt + t/cmd + alt + r | Task |
ctrl + alt + u/cmd + alt + u | Unordered List |
ctrl + alt + o/cmd + alt + o | Ordered List |
ctrl + alt + q/cmd + alt + q | BlockQuote |
ctrl + alt + h/cmd + alt + h | Inline Code (highlight) |
ctrl + alt + c/cmd + alt + c | Code Block |
ctrl + alt + l/cmd + alt + l | Horizontal Line |
ctrl + alt + n/cmd + alt + n | Indent |
ctrl + alt + m/cmd + alt + m | Outdent |
tui.editor is integrated as the markdown editor
Please check the Releases | Github page of this project.
Have a look at our contribution guide.
Thanks goes to these wonderful people (emoji key):