Skip to content

Commit

Permalink
* updated readme for new version 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mohzy83 committed Feb 22, 2019
1 parent b7f4cbf commit 68491d6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Plugin to preview Markdown files in Notepad++
- lightweight plugin to preview markdown within Notepad++
- displaying rendered markdown html with embedded IE11

### Current Version

The current version is **0.3.0**

### Used libs and icons

Using **CommonMark.NET** by Knagis - [https://github.com/Knagis/CommonMark.NET](https://github.com/Knagis/CommonMark.NET)

Using **NotepadPlusPlusPluginPack.Net** by kbilsted - [https://github.com/kbilsted/NotepadPlusPlusPluginPack.Net](https://github.com/kbilsted/NotepadPlusPlusPluginPack.Net)
Expand All @@ -12,11 +18,14 @@ Using Markdown style **github-markdown-css** by sindresorhus - [https://github.c

Using portions of nea's **MarkdownViewerPlusPlus** Plugin code - [https://github.com/nea/MarkdownViewerPlusPlus](https://github.com/nea/MarkdownViewerPlusPlus)

Using the **Markdown icon** by dcurtis - [https://github.com/dcurtis/markdown-mark](https://github.com/dcurtis/markdown-mark)
Using the **Markdown icon** by dcurtis - [https://github.com/dcurtis/markdown-mark](https://github.com/dcurtis/markdown-mark)

## Prerequisites
- .NET 4.5 or higher

## Installation

Just extract the appropriate zip (x86 or x64) to your Notepad++ plugin folder (e.g. "C:\Program Files\Notepad++\plugins").
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:

Expand All @@ -30,3 +39,10 @@ Thats all you need to do ;)

![npp-preview](help/npp-preview.png "Layout of the plugin folder after installation")

### Feature - Synchronize viewer with caret position

![npp-sync-caret](help/sync_caret.gif "Synchronize viewer with caret position")

## License

This project is licensed under the MIT License - see the LICENSE.txt file for details
Binary file added help/sync_caret.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 68491d6

Please sign in to comment.