Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/craigbarnes/showdown

Moved to https://gitlab.com/craigbarnes/showdown
https://github.com/craigbarnes/showdown

flatpak gtk markdown markdown-viewer vala viewer webkit2gtk

Last synced: 2 months ago
JSON representation

Moved to https://gitlab.com/craigbarnes/showdown

Host: GitHub
URL: https://github.com/craigbarnes/showdown
Owner: craigbarnes
License: gpl-3.0
Created: 2013-03-17T19:07:13.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2022-04-10T06:11:39.000Z (almost 3 years ago)
Last Synced: 2023-05-14T21:01:06.457Z (over 1 year ago)
Topics: flatpak, gtk, markdown, markdown-viewer, vala, viewer, webkit2gtk
Language: Vala
Homepage:
Size: 257 KB
Stars: 58
Watchers: 4
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        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

----------

![Showdown screenshot](https://craigbarnes.bitbucket.io/img/showdown.png)

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][POSTINSTALL] 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

-------

Copyright (C) 2015-2018 Craig Barnes

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.

[CADT]: https://www.jwz.org/doc/cadt.html

[General Public License version 3]: https://www.gnu.org/licenses/gpl-3.0.html

[Markdown]: https://en.wikipedia.org/wiki/Markdown

[Vala]: https://wiki.gnome.org/Projects/Vala

[GTK]: https://www.gtk.org/

[GLib]: https://developer.gnome.org/glib/

[GNU Make]: https://www.gnu.org/software/make/

[Discount]: http://www.pell.portland.or.us/~orc/Code/discount/

[WebKit2GTK]: https://webkitgtk.org/

[desktop-file-utils]: https://www.freedesktop.org/wiki/Software/desktop-file-utils/

[libxml2]: http://www.xmlsoft.org/

[`DESTDIR`]: https://www.gnu.org/prep/standards/html_node/DESTDIR.html

[install path variables]: https://gitlab.com/craigbarnes/showdown/blob/master/GNUmakefile#L9-L15

[POSTINSTALL]: https://gitlab.com/craigbarnes/showdown/blob/master/GNUmakefile#L21-25