Skip to content
A gedit plugin previewing markdown (.md) documents
Python Shell CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
markdown_preview add shortcuts for titles May 10, 2019
LICENSE Initial commit Mar 13, 2018
POTFILES fix #7 Nov 14, 2018
README.md Remember the scroll position using horrible javascript async calls Nov 14, 2018
example.css installation script + example of stylesheet Mar 13, 2018
install.sh Better installation script and error handling Mar 17, 2018
markdown_preview.plugin
org.gnome.gedit.plugins.markdown_preview.gschema.xml add shortcuts for titles May 10, 2019
todo.md Minor things Mar 11, 2019
uninstall.sh Better installation script and error handling Mar 17, 2018
update-and-compile-translations.sh fix #7 Nov 13, 2018

README.md

Gedit Markdown Preview

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

Main features (v0.8):

  • show a preview of a file
  • dynamically update the preview (while remembering the position in the page)
  • zoom in or out on the preview
  • export your preview (to any format supported by pandoc)
  • print your preview
  • search in the preview
  • insert an image in your file or other markdown tags in your text

Screenshots

With the preview in the bottom panel, slideshow mode, searching

With the preview in the side panel, menu opened


Dependencies

  • gedit (of course)
  • python3-markdown (that's the name for debian-based distros)
  • pandoc
  • maybe libwebkit2gtk-4.0-dev (that's the name for debian-based distros)

Installation

  • Download the project & extract the archive (or clone the repo).
  • Open the project's folder gedit-plugin-markdown_preview-master in a terminal
  • Run the install.sh script

The script install.sh can be executed as root (installation system-wide) or as a normal user (installation user-wide, but it works only with some systems, weirdly).

Configuration

In gedit's preferences → plugins, some settings are available:

  • The preview can be generated (and exported) with pandoc or python-markdown. A set of extensions is available with python-markdown.
  • A stylesheet (CSS file) can be applied to the preview.
  • Chose if you want the plugin to understand relative paths (for links and pictures). Not recommended if you use special characters in filenames (WebKit2GTK can't load URIs with special characters for some reason)

Available languages

  • English
  • Theorically french, but in fact it's broken
You can’t perform that action at this time.