NppMarkdownPanel
NppMarkdownPanel copied to clipboard
Lightweight Notepad++ plugin to preview Markdown files
NppMarkdownPanel
Plugin to preview Markdown files in Notepad++
- lightweight plugin to preview markdown within Notepad++
- displaying rendered markdown html with embedded IE11
- can save rendered html to a file
Current Version
The current version is 0.6.2 it can be found here
Used libs and icons
Using Markdig v 0.16.0 by xoofx - https://github.com/lunet-io/markdig
Using NotepadPlusPlusPluginPack.Net by kbilsted - https://github.com/kbilsted/NotepadPlusPlusPluginPack.Net
Using Markdown style github-markdown-css by sindresorhus - https://github.com/sindresorhus/github-markdown-css
Using portions of nea's MarkdownViewerPlusPlus Plugin code - https://github.com/nea/MarkdownViewerPlusPlus
Using the Markdown icon by dcurtis - https://github.com/dcurtis/markdown-mark
Prerequisites
- .NET 4.5 or higher
Installation
Installation over Notepad++
The plugin can be installed over the integrated Notepad++ "Plugin Admin..".
Manual Installation
Create the folder "NppMarkdownPanel" in your Notepad++ plugin folder (e.g. "C:\Program Files\Notepad++\plugins") and extract the appropriate zip (x86 or x64) to it.
It should look like this:
Usage
After the installation you will find a small purple markdown icon in your toolbar. Just click it to show the markdown preview. Click again to hide the preview. Thats all you need to do ;)
Settings
To open the settings for this plugin: Plugins -> NppMarkdownPanel -> Edit Settings
-
CSS File
This allows you to select a CSS file to use if you don't want the default style of the preview
-
Zoom Level
This allows you to set the zoom level of the preview
-
Automatic HTML Output
This allows you ot select a file to save the rendered HTML to every time the preview is rendered. This is a way to automatically save the rendered content to use elsewhere. Leaving this empty disables the automatic saving.
Note: This is a global setting, so all previewed documents will save to the same file. -
Show Toolbar in Preview Window
Checking this box will enable the toolbar in the preview window. By default, this is unchecked.
Preview Window Toolbar
-
Save As... (
Clicking this button allows you to save the rendered preview as an HTML document.)
Synchronize viewer with caret position
Enabling this in the plugin's menu (Plugins -> NppMarkdownPanel) makes the preview panel stay in sync with the caret in the markdown document that is being edited.
This is similar to the Synchronize Vertical Scrolling option of Notepad++ for keeping two open editing panels scrolling together.
Version History
Version 0.6.2 (released 2022-06-02)
Bugfix release
- viewer was crashed by too large documents (more than 10000 bytes)
Version 0.6.1 (released 2022-05-26)
- fix embedded images
- fix dark icon
Version 0.6.0 (released 2022-05-26)
- plugin headers for npp updated
- darkmode icon
- fixed refresh bug for 64-bit version of plugin
- new zoom level range from 40 % to 400%
- save html
- images for help file now included
Version 0.5.0
- change zoomlevel for the preview in settings dialog
- change css file for the markdown style
- the new settings are persistent
- open settings dialog: Plugins-> NppMarkdownPanel -> Edit Settings
Version 0.4.0
- switched from CommonMark.Net to markdig rendering library
Version 0.3.0
- synchronize viewer with caret position
Version 0.2.0
- Initial release
Feature - Synchronize viewer with caret position
License
This project is licensed under the MIT License - see the LICENSE.txt file for details