Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ondratu/formiko

reStructuredText editor and live previewer
https://github.com/ondratu/formiko

Last synced: 2 days ago
JSON representation

reStructuredText editor and live previewer

Awesome Lists containing this project

README 

        
Formiko

=======



:author: Ondřej Tůma 



Formiko is reStructuredText and MarkDown editor and live previewer. It is

written in Python with Gtk3, GtkSourceView and Webkit2. Use Docutils and

MarkDown to reStructuredText covertor. If you want to **donate** development,

you can do by `paypal link `_.



Features:

---------

* GtkSourceView based editor with syntax highlighting

* possible use Vim editor

* vertical or horizontal window splitting

* preview mode with auto scroll

* periodic save file

* json and html preview

* spell check

* linked file opening



It support these parsers and writers:



* Docutils reStructuredText parser - http://docutils.sourceforge.net

* MarkDown to reStructuredText convertor (M2R) -

  https://github.com/miyakogi/m2r

* Docutils HTML4, S5/HTML slide show and PEP HTML writer -

  http://docutils.sourceforge.net

* Tiny HTML writer - https://github.com/ondratu/docutils-tinyhtmlwriter

* Yet another HTML writer - https://github.com/masayuko/docutils-htmlwriter

* HTML 5 writer - https://github.com/Kozea/docutils-html5-writer



Vim support

~~~~~~~~~~~

Formiko have Neovim editor support aka ``formiko-vim`` command. This run `Neovim

`_ editor in Vte.Terminal.



Requirements:

-------------

* python 3

* GTK+3

* gobject-introspection

* PyGObject

* Webkit2 4.x

* GtkSourceView 3.x

* gir files for all Gtk libraries

* GtkSpell3

* vte - neovim support

* docutils - reStrucured support



recommended:

~~~~~~~~~~~~

* m2r - converting MarkDown to reStructuredText

* Pygments - syntax color in html output code blocks



optionally:

~~~~~~~~~~~

**Python**:



* docutils-tinyhtmlwriter

* docutils-html5-writer



**System**:



* neovim and pynvim for ``formiko-vim``



development:

~~~~~~~~~~~~



* pygobject-stubs



Installation

------------



Flatpak

~~~~~~~

Formiko exist in Flathub repository as cz.zeropage.Formiko. If you are new with

Flatpak, see `setup guide `_.



.. code:: sh



  # add Flathub repository as root

  flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo



  # install Formiko as user

  flatpak install flathub cz.zeropage.Formiko



  # run Formiko

  flatpak run cz.zeropage.Formiko



Debian based

~~~~~~~~~~~~

Debian based distributions use sometimes versions in package names. Here are

example for Debian Stretch version. If you use different version, your

gtksource or webkit2 could have another version name.



.. code:: sh



    # python3.5, gtk3, librsvg etc are in dependencies

    apt install python3-pip python3-gi python3-docutils gir1.2-gtksource-4 \

                gir1.2-webkit2-4.1 gir1.2-gtkspell3-3.0 gir1.2-vte-2.91 \

                python3-mr2

    pip3 install formiko



    # optionally

    apt install neovim python3-pynvim

    pip3 install docutils-tinyhtmlwriter docutils-html5-writer



**Formiko is in Debian and Ubuntu repository**. So you can install it standard

way.



NetBSD

~~~~~~

**Broken at this moment due missing vte-2.91**



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.



Installation process can be different for each BSD releases. It's about which

Python release is default. By this, you can change ``pyXX`` to your right

version.



NetBSD use pkgsrc, so some binaries are stored in ``/usr/pkg/bin`` directory.

Formiko call neovim directly. If you want to use neovim version with

pkgsrc, you must fix ``VIM_PATH`` variable in ``formiko/vim.py`` file.



.. code:: sh



    # python3.6 is in dependencies as like gtk3

    pkgin install py36-pip py36-gobject3 py36-docutils gtksourceview4 \

                  librsvg webkit-gtk py36-pygments

    pip3.6 install m2r formiko



    # optionally

    pkgin install neovim pynvim

    pip3.6 install docutils-tinyhtmlwriter docutils-html5-writer



FreeBSD

~~~~~~~

**Broken at this moment due missing vte-2.91**



Installation process can be different for each BSD releases. It's about which

Python release is default. By this, you can change ``pyXX`` to your right

version.



On FreeBSD you must install all these packages:



.. code:: sh



    pkg install py37-gobject3 py37-docutils py37-pygments py37-pip \

        gtksourceview4 webkit2-gtk3 gtkspell3 gobject-introspection \

        librsvg2 adwaita-icon-theme



**Optionaly**



.. code:: sh



    pkg install en-hunspell  # or other language you want

    pip-3.7 install docutils-tinyhtmlwriter docutils-html5-writer m2r