Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/maoschanz/gedit-plugin-markdown_preview

A gedit plugin previewing markdown (.md) documents
https://github.com/maoschanz/gedit-plugin-markdown_preview

gedit gedit-plugin gnome gnome-desktop markdown pandoc pandoc-markdown

Last synced: 2 months ago
JSON representation

A gedit plugin previewing markdown (.md) documents

Awesome Lists containing this project

README 

        

# Gedit Markdown Preview



This is a plugin for the Gedit text editor, previewing .md files in the side

pane (F9) or the bottom (Ctrl+F9) pane.



### Previewing



- show a preview of a file

- dynamically update the preview

- zoom in or out on the preview

- search in the preview

- open links and images



This works for Markdown, HTML, and SVG files.



### Exporting



You can print the preview, or export it:



- if [`pandoc`](https://pandoc.org/) is installed on your system, you can export to any format it supports

	- a stylesheet can be applied to most file formats

	- be careful if you want to export to PDF: pandoc doesn't come with all necessary dependencies by default

- if only `python3-markdown` is installed, you can export to HTML

	- a stylesheet can be applied

	- `python3-markdown` [extensions](https://python-markdown.github.io/extensions/) can be used (including [third-party extensions](https://github.com/Python-Markdown/markdown/wiki/Third-Party-Extensions) like [these great ones](https://facelessuser.github.io/pymdown-extensions/)



### Editing assistance



- insert an image in your file

- insert markdown tags in your text from the right-click menu



---



## Screenshots



| With the preview in the side pane, menu opened | With the preview in the bottom pane, searching |

|------|------|

| ![With the preview in the side pane, menu opened](https://i.imgur.com/wo2pUrR.png) | ![With the preview in the bottom pane, searching](https://i.imgur.com/NaVogWH.png) |



---



## Installation



### Packages



- For Arch Linux and its derivatives: the [AUR](https://aur.archlinux.org/packages/gedit-plugin-markdown_preview) package is named `gedit-plugin-markdown_preview`.



Even if you install the plugin with a package manager, you may like to read the

following sections, since installing optional dependencies will enable new

features of the plugin.



### Manual installation



1. Dependencies. Be sure to have these packages before installing the plugin:

  - `gedit` (≥3.22)

  - `gir1.2-webkit2-4.0`

  - `python3-markdown` or `pandoc`

  - if you want to export to PDF with pandoc, you'll need at least `pdflatex`

    and `lmodern`. Those are provided by `texlive` packages whose names vary

    depending on the distribution. Warning: the version provided by Debian is

    sadly broken (some error message about *xcolor.sty*).

  - `libglib2.0-bin` (needed for the installation script only). This is the

    package name on debian-based distros, it may differ on your system.

2. Download the ZIP of [the last release](https://github.com/maoschanz/gedit-plugin-markdown_preview/releases).

3. Extract the archive.

4. Open the project's folder in a terminal.

5. Run `./install.sh` — it can be executed as root (system-wide installation) or

   as a normal user (user-wide installation).



## Activation



The plugin is now installed and has to be enabled:



- Open Gedit's preferences.

- Go to the "Plugins" tab.

- Enable the "Markdown Preview" plugin.



---



## Configuration



The plugin's options can be accessed…



- from Gedit's preferences → Plugins → Markdown preview → Preferences

- or with the plugin's "3-dots menu" → Options



### General options



- Position of the preview (left side or bottom)

- If you want the plugin to understand relative paths (for links and pictures). This is not recommended if you use special characters in filenames (some versions of WebKit2GTK can't load URIs with special characters for some reason)



### Rendering options



The preview can be generated with [pandoc](https://pandoc.org/) or

[python-markdown](https://python-markdown.github.io/).



A stylesheet (CSS file) can be applied to the preview (markdown files only, it

will not be loaded for HTML files).



##### Options with python-markdown



A set of [extensions](https://python-markdown.github.io/extensions/) is provided

natively with python-markdown. You can enable or disable them depending on your

needs.



[Great third-party extensions](https://facelessuser.github.io/pymdown-extensions/)

exist too, and once installed they can be added manually to the list.



---



## Available languages



- English

- French

- Dutch