apostrophe  v2.4
About: Apostrophe is a minimalist text editor supporting Markdown (requires GTK+).
  Fossies Dox: apostrophe-v2.4.tar.bz2  ("unofficial" and yet experimental doxygen-generated source code documentation)  

apostrophe Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies apostrophe-v2.4.tar.bz2 contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.md

Please do not theme this app

Apostrophe

About

Apostrophe is a GTK+ based distraction free Markdown editor, mainly developed by Wolf Vollprecht and Manuel Genov├ęs. It uses pandoc as back-end for parsing Markdown and offers a very clean and sleek user interface.

Install

Download on Flathub

Also several unofficial builds are available:

Translation

If you want to help translating the project, please join us at Poeditor. Any help is appreciated!

Building

Building using GNOME Builder

GNOME Builder offers the easiest method to build Apostrophe. Just follow this guide and you'll be up and running in a minute.

Building from Git

To build Apostrophe from source you need to have the following dependencies installed:

  • Build system: meson ninja-build
  • Pandoc, the program used to convert Markdown to basically anything else: pandoc
  • GTK3 and GLib development packages: libgtk-3-dev libglib2.0-dev
  • Rendering the preview panel: libwebkit2gtk
  • Spell checking libraries: gobject-introspection libgirepository1.0-dev gir1.2-gspell1 gettext
  • Python dependencies: python3 python3-regex python3-setuptools python3-levenshtein python3-enchant python3-gi python3-cairo python3-pypandoc
  • optional: AppStream utility: appstream-util
  • optional: pdftex module: texlive texlive-latex-extra
  • optional: formula preview: libjs-mathjax

Depending on your setup you may need to install these schemas before building:

$ sudo cp data/org.gnome.gitlab.somas.Apostrophe.gschema.xml /usr/share/glib-2.0/schemas/org.gnome.gitlab.somas.Apostrophe.gschema.xml
$ sudo glib-compile-schemas /usr/share/glib-2.0/schemas

Once all dependencies are installed you can build Apostrophe using the following commands:

$ git clone https://gitlab.gnome.org/somas/apostrophe/
$ cd apostrophe
$ meson builddir --prefix=/usr -Dprofile=development
$ sudo ninja -C builddir install

Then you can run the installed package:

$ apostrophe

Or a local version which runs from the source tree

$ ./builddir/local-apostrophe

Building a flatpak package

It's also possible to build, run and debug a flatpak package. All you need is to setup flatpak-builder and run the following commands:

$ cd build-aux/flatpak
$ flatpak-builder --force-clean --install --user _build org.gnome.gitlab.somas.Apostrophe.json