Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apostropheeditor/apostrophe
Mirror of
https://github.com/apostropheeditor/apostrophe
distraction-free gtk markdown markdown-editor python
Last synced: about 8 hours ago
JSON representation
Mirror of
- Host: GitHub
- URL: https://github.com/apostropheeditor/apostrophe
- Owner: ApostropheEditor
- License: gpl-3.0
- Created: 2014-07-06T19:59:55.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-10-26T03:33:34.000Z (almost 2 years ago)
- Last Synced: 2024-09-24T21:15:22.904Z (about 13 hours ago)
- Topics: distraction-free, gtk, markdown, markdown-editor, python
- Language: Python
- Homepage: https://gitlab.gnome.org/World/apostrophe
- Size: 11.9 MB
- Stars: 412
- Watchers: 18
- Forks: 45
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://stopthemingmy.app)
# Apostrophe
## About
Apostrophe is a [GTK+](https://www.gtk.org) 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
Also several unofficial builds are available:
* Nix(OS): [`pkgs.apostrophe`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/apostrophe/default.nix)
* Arch Linux (AUR)
* [Fedora](https://src.fedoraproject.org/rpms/apostrophe): `sudo dnf install apostrophe`
## Translation
If you want to help translating the project, please join us at [Poeditor](https://poeditor.com/join/project/gxVzFyXb2x).
Any help is appreciated!
## Building
### Building using GNOME Builder
GNOME Builder offers the easiest method to build Apostrophe. Just follow [this guide](https://wiki.gnome.org/Newcomers/BuildProject) 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:
```bash
$ 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:
```bash
$ 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:
```bash
$ apostrophe
```
Or a local version which runs from the source tree
```bash
$ ./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](https://docs.flatpak.org/en/latest/first-build.html) and run the following commands:
```bash
$ cd build-aux/flatpak
$ flatpak-builder --force-clean --install --user _build org.gnome.gitlab.somas.Apostrophe.json
```