Skip to content
vdasusPublic

About

Markdown preview plugin for Far Manager 3: rendered view with word wrap, colours and Colorer-highlighted code blocks; F6 switches to the source.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Latest commit

 

History

27 Commits

Folders and files

Repository files navigation

MarkFar

A Markdown preview plugin for Far Manager 3: open a .md file and read it rendered, with syntax highlighting, inside Far.

MarkFar: F3 opens the preview, F2 toggles wrap, F6 switches to the source and back

Requires Far Manager 3 x64 (tested with build 6699). Colorer, which ships with Far, colours the code blocks.

Install

  1. Download MarkFar-<version>-x64.zip from Releases.

  2. Close Far Manager.

  3. Unpack the zip. It contains the folder MarkFar and these steps as INSTALL.txt (English, Russian, Lithuanian). Copy the folder into the plugins folder of your Far profile:

    %APPDATA%\Far Manager\Profile\Plugins
    

    (paste the line into the Explorer address bar; create Plugins if it does not exist). The result is %APPDATA%\Far Manager\Profile\Plugins\MarkFar\MarkFar.dll. No administrator rights are needed.

    Or copy it into the Plugins folder of the Far installation, next to Far.exe, for example C:\APP\Far3\Plugins. Far loads plugins from both places. Under C:\Program Files this needs administrator rights.

  4. Start Far. F11 now lists "MarkFar".

That is all. On its first start MarkFar sets itself up:

  • F3 on a .md file in a panel opens the preview (Alt+F3 still opens Far's viewer).
  • Code blocks are coloured by Colorer: MarkFar registers its scheme file with Colorer. If Colorer's "Custom schemas folder (hrc)" is empty, MarkFar points it at the plugin's hrc folder; if it already names another folder, MarkFar copies markfar.hrc there. Colorer picks this up after a restart of Far at the latest.

The first start takes longer: Colorer shows "Reloading schema library..." for a few seconds while it loads MarkFar's scheme. This happens once, after installation; later starts are as fast as before.

Both can be switched off in F9 → Options → Plugins configuration → MarkFar; switching off undoes the change.

Update: close Far, replace the MarkFar folder with the new one, start Far. Remove: switch both settings above off, close Far, delete the folder.

Use

Key In the preview
F2 Word wrap on/off
F6 Switch to the file in Far's editor; F6 there (or Esc after saving) returns to the updated preview
Ctrl+Down / Ctrl+Up Next / previous heading
Esc Close
F1 Help

Settings: F9 → Options → Plugins configuration → MarkFar. Help: F1 in the preview, in English, Russian and Lithuanian.

Building from source: docs/dev-install.md. Design notes: docs/.

Third-party code

  • md4c 0.6.0, MIT license (third_party/md4c).
  • Far Manager plugin SDK headers, BSD 3-Clause license (sdk/).

Authorship

The code and documentation in this repository are written by Claude (an AI model by Anthropic) under the supervision of vdasus, who sets the direction, reviews the work and decides what goes in.

License and disclaimer

Released under the BSD Zero Clause License (0BSD): use, copy, modify and distribute it for any purpose, with or without fee, without any obligation, including attribution.

The software is provided "as is", without warranty of any kind. The author accepts no responsibility or liability for any damage, data loss or other consequences of using it. Use it at your own risk.

About

Markdown preview plugin for Far Manager 3: rendered view with word wrap, colours and Colorer-highlighted code blocks; F6 switches to the source.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages