Project Status

Unmaintained

I've lost all interest in working on GTK projects and probably won't be making any further updates to the showdown code.

The CADT development model is stronger than ever in the GNOME ecosystem and I no longer find it worth the effort to fix the constant breakage it causes.

Showdown

Showdown is a simple Markdown viewer written in Vala and GTK.

Features

Minimalist default stylesheet.
Table of contents navigation.
Integrated search bar
User styles (~/.config/showdown/stylesheet.css)
User scripts (~/.config/showdown/script.js)

Screenshot

Building

To build Showdown from source, first install the following runtime dependencies:

GTK (3.20+)
GLib (2.48+)
WebKit2GTK (2.8.4+)
Discount (2.1.7+)

...and the following build dependencies:

Vala
GNU Make (3.81+)
desktop-file-install (from desktop-file-utils)
xmllint (from libxml2)

...which are available via package manager on most Linux distros:

# Debian 8+/Ubuntu 15.04+:
sudo apt-get -y install valac gcc make libgtk-3-dev libwebkit2gtk-4.0-dev libmarkdown2-dev libxml2-utils

# Fedora 21+:
sudo dnf -y install vala gcc make webkitgtk4-devel libmarkdown-devel libxml2

# Arch Linux
sudo pacman --needed -Sy vala gcc make webkit2gtk discount libxml2

...then download and extract the latest release tarball:

curl -LO https://craigbarnes.gitlab.io/dist/showdown/showdown-0.6.tar.gz
tar -xzf showdown-0.6.tar.gz
cd showdown-0.6/

...and compile and install:

make && sudo make install

Packaging

Variables:

The makefile supports most common packaging conventions, such as the DESTDIR variable and various other install path variables.

Example usage:

make V=1
make install V=1 prefix=/usr DESTDIR=PKG

Post-install commands:

The makefile automatically updates the system icon and MIME type caches after installation, unless the DESTDIR variable is set.

If DESTDIR is set, it is assumed that the installation is being used for packaging purposes, in which case the packager should use the equivalent, distro-provided macros/hooks instead. The icon and MIME type caches should also be updated after uninstallation.

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License version 3 for more details.

craigbarnes / showdown