Skip to content

Lightweight Notepad++ plugin to preview Markdown files

License

Notifications You must be signed in to change notification settings

ezyuzin/NppAnotherMarkdown

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AnotherMarkdown for Notepad++

A plugin for previewing Markdown files in Notepad++.

  • Lightweight plugin to preview Markdown within Notepad++
  • Displays rendered Markdown HTML using WebView2 (Edge)

The plugin is a fork of the NppMarkdownPanel plugin and uses the markdown-it javascript library to render Markdown documents into HTML and allows configuring used Markdown extensions without recompiling or reinstalling the plugin (just edit assets/markdown/markdown.js).

Supported markdown extensions (out-of-box)

Extension Description
abbr Add abbreviation tag <abbr> support
alert GFM style alerts
align Plugin to align contents
attrs Add attrs to Markdown content
container Creating block-level custom containers
dl Definition list
emoji Emoji
figure Generating figures with captions from images
footnote Footnotes
highlight.js Code syntax highlight
icon Icons
imgLazyLoad Lazy loading for images
imgMark Mark images by ID suffix for theme mode
imgSize Add support setting size for images
ins Аdd <insert> tag support
katex Math Expressions
mark Mark and highlight contents
pano360 Editing and preview interactive 360-degree panoramic photos. It uses panellum library and invokes with markdown markup syntax {% pano360 path_to_scene %}. Example can be found here.
Editing index.pano360.json in Notepad++ allow interactive add hotspots and transition between photos, makes scene editing easier.
plantuml Add support plant uml schemes
ruby Ruby annotation <ruby>
qrcode Display QRCode from string {% qrcode text="ABC" %}
spoiler Plugin for hide content
stylize Plugin for stylizing tokens
sub Plugin to support subscript
sup Plugin to support superscript
tab Block-level custom tabs

Latest Version

The latest version can be found here.

ChangeLog

Differences between versions can be found here.

Prerequisites

  • Windows
  • .NET 4.7.2 or higher

Installation

Installation in Notepad++

The plugin can be installed with the Notepad++ Plugin Admin. The name of the plugin is AnotherMarkdown.

Manual Installation

Create the folder "AnotherMarkdown" 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:

Issues with manual installation: Windows blocks downloaded DLLs by default. That means you likely get the following error message:

Failed to load
AnotherMarkdown.dll is not compatible with the current version of Notepad++

Make sure to unblock all DLLs of the plugin (also DLLs in subfolders).
npp-unblock

Note for Windows 7 users: WebView2 Edge is required for the plugin to function properly. Windows 7 does not include WebView2 Edge by default, so you must manually install the WebView2 Runtime from Microsoft's WebView2 download page before using the plugin. https://developer.microsoft.com/en-us/microsoft-edge/webview2?form=MA13LH#download

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 ;)

With dark mode enabled in Notepad++

Settings

To open the settings for this plugin: Plugins -> AnotherMarkdown -> Settings

  • CSS File

    This allows you to select a CSS file to use if you don't want the default style of the preview

  • Dark mode CSS File

    This allows you to select a Dark mode CSS file. When the Notepad++ dark mode is enabled, this Css file is used. When no file is set, the default dark mode Css is used.

  • Zoom Level

    This allows you to set the zoom level of the preview

  • Show Toolbar in Preview Window

    Checking this box will enable the toolbar in the preview window. By default, this is unchecked.

  • Show Statusbar in Preview Window (Preview Links)

    Checking this box will show the status bar, which previews urls for links. By default, this is unchecked.

Synchronize viewer with caret position

Enabling this in the plugin's menu (Plugins -> AnotherMarkdown) 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.

Synchronize with first visible line in editor

When this option is enabled, the plugin ensures that the first visible line in the editor is also visible in the preview. (This is an alternative to Synchronize viewer with caret position)

Used libs and resources

Name Version Authors Link
NotepadPlusPlusPluginPack.Net 0.95 kbilsted https://github.com/kbilsted/NotepadPlusPlusPluginPack.Net
NppMarkdownPanel 0.9.0 mohzy83 https://github.com/mohzy83/NppMarkdownPanel
EdgeViewer 1.0.9 rg-software https://github.com/rg-software/wlx-edge-viewer
WebView2 Edge 1.0.3296.44 Microsoft https://developer.microsoft.com/de-de/microsoft-edge/webview2?form=MA13LH
Markdown Icon dcurtis https://github.com/dcurtis/markdown-mark

Contributors

License

This project is licensed under the MIT License - see the LICENSE.txt file for details

About

Lightweight Notepad++ plugin to preview Markdown files

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 69.0%
  • JavaScript 22.6%
  • TypeScript 3.4%
  • CSS 3.3%
  • HTML 1.3%
  • PowerShell 0.3%
  • Batchfile 0.1%