2019-05-24 06:30:50 +00:00
[](https://stopthemingmy.app)
2020-03-15 00:11:37 +00:00
# Apostrophe
2014-10-04 22:46:48 +00:00
2018-05-20 12:28:50 +00:00
2019-10-30 00:28:18 +00:00
## About
2018-04-20 22:54:08 +00:00
2020-03-15 00:11:37 +00:00
Apostrophe is a GTK+ based distraction free Markdown editor, mainly developed by Wolf Vollprecht and Manuel Genovés. It uses pandoc as backend for markdown parsing and offers a very clean and sleek user interface.
2015-05-19 20:19:16 +00:00
2019-10-30 00:28:18 +00:00
## Install
2018-05-20 12:28:50 +00:00
2020-03-15 00:11:37 +00:00
You can get Apostrophe on Flathub!
2018-05-20 12:28:50 +00:00
[Get it now ](https://flathub.org/apps/details/de.wolfvollprecht.UberWriter )
2019-10-30 00:28:18 +00:00
## Contributions and localization
2018-04-20 22:54:08 +00:00
If you want to help to localize the project, just join us at [Poeditor ](https://poeditor.com/join/project/gxVzFyXb2x )
Any help is appreciated!
2019-10-30 00:28:18 +00:00
## Building from Git
```bash
2020-03-15 00:11:37 +00:00
$ git clone https://github.com/Apostrophe/apostrophe.git
$ cd apostrophe
2019-10-30 00:28:18 +00:00
$ meson builddir --prefix=/usr
# sudo ninja -C builddir install
```
2018-04-20 22:54:08 +00:00
2020-03-15 00:11:37 +00:00
To use apostrophe, please make sure you have some dependencies installed:
2015-05-19 20:19:16 +00:00
- Pandoc, the program used to convert Markdown to basically anything else (the package name should be pandoc in most distributions)
- Of course, gtk3 etc. needs to be installed as well since this is a gtk application
2018-05-20 12:28:50 +00:00
- webkit2gtk is also needed for the preview panel
2018-04-11 19:28:15 +00:00
- Please find these packages on your distribution: `python3 python3-regex python3-setuptools python3-levenshtein python3-enchant python3-gi python3-cairo`
2018-05-20 12:28:50 +00:00
- Optional dependencies are `texlive` for the pdftex module.
2015-06-07 09:26:41 +00:00
2019-10-30 00:28:18 +00:00
### Running it without installing it
2018-04-11 19:28:15 +00:00
2020-03-15 00:11:37 +00:00
You can run Apostrophe with `./apostrophe.in` without installing it in the system,
2019-10-30 00:28:18 +00:00
but you'll need to install and compile the schemas before:
2018-04-11 19:28:15 +00:00
2019-10-30 00:28:18 +00:00
```bash
# sudo cp data/de.wolfvollprecht.UberWriter.gschema.xml /usr/share/glib-2.0/schemas/de.wolfvollprecht.UberWriter.gschema.xml
# sudo glib-compile-schemas /usr/share/glib-2.0/schemas
```
2018-04-11 19:28:15 +00:00
2019-10-30 00:28:18 +00:00
### Building a flatpak package
2018-04-11 19:28:15 +00:00
2019-10-30 00:28:18 +00:00
It's also possible to build, run and debug a flatpak package. You'll need flatpak-builder for this:
2018-04-11 19:28:15 +00:00
2019-10-30 00:28:18 +00:00
```bash
$ cd build-aux/flatpak
$ flatpak-builder --force-clean --install --user _build de.wolfvollprecht.UberWriter.json
```
