Skip to content

step-/mdview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MDVIEW MTX Readme

MDVIEW MTX is a graphical Markdown viewer and CLI converter supporting the CommonMark specification version 0.31.2. It runs on Linux with the GTK+ 3 toolkit.

Screenshot

screenshot
GTK Theme: Adwaita. Openbox theme: macOS.

Features

  • GTK-3 Graphical Viewer for text and images (GTK-2 also available)
  • Command to convert Markdown to HTML5, XHTML, text, text with ANSI or VT100 escapes
  • Page and directory search
  • Document and link navigation
  • Hotkeys
  • One-click export to web browser
  • Extensions available
  • Translation ready -- Gettext POT file here
  • Documentation

Read the command help page and the welcome page.

Components

MDVIEW MTX utilizes the following FOSS components. I appreciate the contributions these excellent software packages make to my project:

  • MD4C -- "C Markdown parser compliant to the CommonMark specification".
  • github-markdown-css -- "Minimal amount of CSS to replicate the GitHub style".

Dependencies

  • Unix-like OS (development and testing takes place on Linux).
  • GTK-3 or GTK-2. Refer to the INSTALL document for specific supported versions.
  • GNU make or compatible make program, and pkg-config for development.
  • Meson-based build included.

Building and installing

Refer to the INSTALL document for instructions.

License

GNU General Public License Version 2.

Project History

MDVIEW MTX is a continuation of the mdview3 project. The MTX part of the name comes from mtx, the three-letter prefix that I use to brand class and function names in the source code. MTX does not mean anything in particular.

Links

About

GTK markdown viewer and CLI converter

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages