Skip to content

Commit 2fd4f9e

Browse files
author
Savas Ziplies
committed
Added: Description
1 parent 7b55a37 commit 2fd4f9e

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed
Loading

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ A Notepad++ Plugin to view a Markdown file rendered on-the-fly
1919
## Latest Versions
2020
* 0.6.0
2121
* Updated the [Notepad++ PluginPack.net][2] for better x64 support and first x64 release
22+
* Extended the documentation by a description about the included *Options*
23+
* Added a MSBuild target to produce release zips automatically
2224
* 0.5.1
2325
* Fixed a bug always returning false while checking file extensions
2426
* 0.5.0
@@ -49,6 +51,24 @@ To synchronize the scrolling between the Notepad++ editor view and the rendered
4951

5052
![MarkdownViewer++](https://github.com/nea/MarkdownViewerPlusPlus/blob/master/MarkdownViewerPlusPlus/Resources/MarkdownViewerPlusPlus.png?raw=true)
5153

54+
### Options
55+
The MarkdownViewer++ offers several options to customize your plugin experience. You can open the options dialog via the **Plugins** sub-menu.
56+
57+
![MarkdownViewer++ Options](https://github.com/nea/MarkdownViewerPlusPlus/blob/master/MarkdownViewerPlusPlus/Resources/MarkdownViewerPlusPlus-Options.png?raw=true)
58+
59+
#### General
60+
On the **General** tab you can configure the file extensions the MarkdownViewer++ renderer should actually display. If the box is *empty* all files will be rendered. If you want to limit the rendering to certain file extensions list them in the textbox as comma-separated list without leading dot.
61+
62+
For example, if you only want to render *txt*, *log* and *md* files just type in "txt,log,md".
63+
64+
Please note that only file extensions are compared and no certain mime types or anything. If a text document is not named *XYZ.txt* it will not be rendered.
65+
66+
#### HTML
67+
On the **HTML** tab you can fill in *Custom CSS*, which is used when rendering the MarkdownViewer++ preview as well as the exported HTML. Therefore, you are able to e.g. change bullet-point-list icons or sizes of headlines. The custom CSS textbox is limited to 32767 characters.
68+
69+
#### PDF
70+
On the **PDF** tab you can set the *orientation* and *page size* of the exported PDF. The content is provided by the [PDFSharp][5] enumerations.
71+
5272
## License and Credits
5373
The MarkdownViewerPlusPlus is released under the MIT license.
5474

0 commit comments

Comments
 (0)