https://github.com/step-/mdview
GTK markdown viewer and CLI converter
https://github.com/step-/mdview
cli commonmark gtk2 gtk3 linux markdown md4c
Last synced: 3 months ago
JSON representation
GTK markdown viewer and CLI converter
- Host: GitHub
- URL: https://github.com/step-/mdview
- Owner: step-
- License: gpl-2.0
- Created: 2024-08-26T19:20:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T17:21:54.000Z (over 1 year ago)
- Last Synced: 2025-02-06T04:44:35.045Z (over 1 year ago)
- Topics: cli, commonmark, gtk2, gtk3, linux, markdown, md4c
- Language: C
- Homepage:
- Size: 1010 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### 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.
* Home:
* Wiki:
* Issue tracker:
### 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
* CommonMark:
* github-markdown-css:
* MD4C:
* Mdview3:
[0.31.2]:
[mdview3]:
[CommonMark]:
[FOSS]:
[github-markdown-css]:
[MD4C]:
[help page]:
[welcome page]:
[Extensions]:
[Documentation]:
[Gettext POT file here]:
[INSTALL]: