Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lesderid/showdown

Simple Markdown viewer, written in Vala and GTK 3 (fork)
https://github.com/lesderid/showdown

desktop-app gtk gtk3 markdown markdown-viewer

Last synced: about 2 months ago
JSON representation

Simple Markdown viewer, written in Vala and GTK 3 (fork)

Host: GitHub
URL: https://github.com/lesderid/showdown
Owner: lesderid
License: gpl-3.0
Created: 2023-12-18T07:27:52.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2023-12-18T07:48:29.000Z (about 1 year ago)
Last Synced: 2024-10-25T09:11:36.857Z (3 months ago)
Topics: desktop-app, gtk, gtk3, markdown, markdown-viewer
Language: Vala
Homepage: https://github.com/lesderid/showdown
Size: 228 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        Showdown

========

This repository is a fork of the [original

Showdown](https://gitlab.com/craigbarnes/showdown/) by [Craig

Barnes](https://gitlab.com/craigbarnes) with some additional features. Please

note that no new release has been created yet, so for now, you should clone this

repo for the new features.

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

Features

--------

* Minimalist default stylesheet

* Table of contents navigation

* Integrated search bar

* Automatic reloading on file changes

* 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, Copyright (C) 2023 Les De Ridder

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://github.com/lesderid/showdown/blob/master/GNUmakefile#L9-L15

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