reStructuredText editor and live previewer
Clone or download
Latest commit 2bc545c Jan 18, 2018

README.rst

Formiko

Author: Ondřej Tůma <mcbig@zeropage.cz>

Formiko is reStructuredText and MarkDown editor and live previewer. It is written in Python with Gtk3, GtkSourceView and Webkit2. Use Docutils and recommonmark Common Mark parser.

Features:

  • GtkSourceView based editor with syntax highlighting
  • possible use Vim editor
  • vertical or horizontal window splitting
  • preview mode
  • periodic save file
  • json and html preview
  • spell check

It support these parsers and writers:

Vim support

Formiko have Vim editor support aka formiko-vim command. This run Vim editor in GtkSocket. At this moment, this socket work only on X11 backend, so this is not work on Wayland yet.

There is bug for GTK+:
Bug 721224 - please add support for GtkSocket/GtkPlug in Wayland backend

Requirements:

  • python 2.7 or 3
  • GTK+3
  • gobject-introspection
  • PyGObject
  • Webkit2 4.x
  • GtkSourceView 3.x
  • gir files for all Gtk libraries
  • GtkSpell3

recommended:

  • docutils - reStrucured support
  • recommonmark - for Common Mark support (MarkDown)
  • Pygments - syntax color in html output code blocks

optionally:

Python:

  • docutils-tinyhtmlwriter
  • docutils-htmlwriter
  • docutils-html5-writer

System:

  • vim-gtk or vim-gnome for formiko-vim

Installation

Debian

Debian use sometimes versions in package names. Here are in Stretch version. If you use different version, your gtksource or webkit2 could have another version name.

# python3.5, gtk3, librsvg etc are in dependencies
apt install python3-pip python3-gi python3-docutils gir1.2-gtksource-3.0 \
            gir1.2-webkit2-4.0 gir1.2-gtkspell3-3.0
pip3 install formiko

# optionaly
apt install vim-gtk3
pip3 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer

Formiko is in Debian repository from Buster. So you can install it standard way.

NetBSD

There is not GtkSpell3 on NetBSD, which is need for next 1.3.x version. So you must use 1.2.x bug fix release.

NetBSD use pkgsrc, so some binaries are stored in /usr/pkg/bin directory. Formiko call vim and gvim directly. If you want to use vim version with pkgsrc, you must fix VIM_PATH variable in formiko/vim.py file.

# python3.6 is in dependecies as like gtk3
pkgin install py36-pip py36-gobject3 py36-docutils gtksourceview3 \
              librsvg webkit-gtk py36-pygments
pip3.6 install formiko

# optionaly
pkgin install vim-gtk3
pip3.6 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer