Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 2.85 KB

Readme.md

File metadata and controls

70 lines (46 loc) · 2.85 KB
Raw

Preview Plugin for Geany

This plugin provides a preview pane for Geany to view the formatting of several light-weight markup languages as they are edited.

Supported document types include AsciiDoc, DocBook, Fountain, HTML, LaTeX, Markdown, MediaWiki, reStructuredText, Textile, and Txt2Tags.

screenshot

Features

  • The preview is updated as the document is edited
  • HTML, Markdown, and Fountain are supported directly
  • Other document formats can be processed with auxiliary programs
  • The preview of large documents can be limited to the area being edited
  • Rendering of each format can customized with stylesheets
  • Dark and light themes are available

Usage

After installation, enabled the plugin using the Plugin Manager (Tools/Plugin Manager). Since this plugin adds a pane to the sidebar, the sidebar must also be shown (View/Show Sidebar).

The preview will be active by default for documents with supported file types. To display formats other than HTML, Markdown, or Fountain, auxiliary programs are needed. If they are unavailable, no preview will be displayed for their respective formats.

More about usage and configuration is available at Certain Queries Answered.

Installation

Build from Source

Those interested may try Building on Linux. Unfortunately, this plugin does not work on Windows because WebKit2GTK is not available. The plugin has not been tested on Mac.

Arch (and derivatives)

An AUR package is available at aur/geany-plugin-preview-git. Clone the package repository and run makepkg. Then install the package with pacman -U.

git clone https://aur.archlinux.org/geany-plugin-preview.git
cd geany-plugin-preview
makepkg
sudo pacman -U geany-plugin-preview-*.pkg.tar.zst

Ubuntu

This plugin can be installed on Ubuntu from PPA. The files have not been tested with other Debian-based distributions, but may work.

sudo add-apt-repository ppa:xiota/geany-plugins
sudo apt-get update
sudo apt-get install geany-plugin-preview

Requirements

This plugin depends on the following libraries and programs:

Optional auxiliary programs may also be used to process additional formats:

License

The Preview plugin for Geany is licensed under GPL-3.0-or-later.

Some code originated from the Code Format and Markdown plugins, which are written by Michael Brush and licensed under GPL-2.0-or-later.