Skip to content

rg-software/wlx-markdown-viewer

Repository files navigation

WLX Markdown Viewer

HTML + Markdown lister plugin for Total Commander (32/64-bit version)

Based on HTMLView 1.2.6 source, this plugin supports the original HTMLView functionality and displays Markdown files via hoedown. Markdown rendering should work reliably for UTF-8 and UTF-16 encoded files (file format is detected with text-encoding-detect). For other encodings, Internet Explorer-based autodetection is used, so results may vary.

Please use this plugin only if you need a lightweight viewer or compatibility with legacy operating systems. More kinds of viewable content are supported by EdgeViewer.

Fine Tuning

Plugin configuration is specified in MarkdownView.ini. Markdown-related settings are:

  • MarkdownExtensions: file extensions recognized by the plugin as markdown files.
  • HoedownArgs: custom arguments passed to the hoedown engine (control fine settings of markdown rendering).
  • UseSmartypants: controls whether smartypants should be invoked after processing.
  • CustomCSS: a path to a CSS sheet for customizing the resulting look of the document. A collection of four sheets from Markdown CSS and six Github-inspired sheets courtesy of S. Kuznetsov is included into the package.

For more information on hoedown arguments and smartypants functionality, check this quick reference.

Internet Explorer Update

The plugin is based on an obsolete Internet Explorer engine, which can be upgraded via registry hacks (check MSDN for details.)

Setup

The binary plugin archive comes with the setup script. Just enter the archive, and confirm installation.

Development

Currently, the project is compiled with Visual Studio 2022. However, if Windows XP support is needed, it should be technically possible to modify project files to use Visual Studio 2019 version 16.7 or earlier with the 141_xp toolset. Project binaries up to v2.5 are compatible with Windows XP.

To run tests, execute

python Hoedown/test/runner.py

You need to have tidy installed.

About

Markdown Lister plugin for Total Commander

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors