• Stars
    star
    116
  • Rank 303,894 (Top 6 %)
  • Language
    Python
  • License
    GNU General Publi...
  • Created over 6 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A gedit plugin previewing markdown (.md) documents

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 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

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 With the preview in the bottom pane, searching

Installation

Packages

  • For Arch Linux and its derivatives: the AUR 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.
  1. Download the ZIP of the last release.
  2. Extract the archive.
  3. Open the project's folder in a terminal.
  4. 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 or python-markdown.

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 is provided natively with python-markdown. You can enable or disable them depending on your needs.

Great third-party extensions exist too, and once installed they can be added manually to the list.


Available languages

  • English
  • French
  • Dutch

More Repositories

1

drawing

Simple image editor for Linux
Python
674
star
2

emoji-selector-for-gnome

This extension provide a popup menu with some emojis ; clicking on an emoji copies it to the clipboard.
JavaScript
461
star
3

dynamic-wallpaper-editor

A little utility for creation or edition of GNOME desktop's XML wallpapers
Python
195
star
4

appfolders-manager-gnome-extension

A GNOME extension allowing easy management of "appfolders" directly from the applications grid.
JavaScript
95
star
5

notes-extension-gnome

A GNOME Shell extension providing customizable sticky notes
JavaScript
76
star
6

quicklists-gnome-shell-extension

Add dynamic quicklists with nautilus bookmarks or recent files.
JavaScript
18
star
7

gedit-plugin-open-as-root

A gedit plugin opening the current document as root
Python
12
star
8

sound-percentage-gs-extension

A GNOME Shell extension displaying the current sound percentage in the system tray.
JavaScript
12
star
9

nautilus-open-with-menu

A simple nautilus extension adding a submenu to the right-click, with a list of apps you can use to open the selected files.
Python
10
star
10

More-columns-in-applications-view

Set the number of columns in the "applications" view.
JavaScript
8
star
11

Places-and-files-direct-access

GNOME Shell extension providing an access to devices, bookmarks and recent files on the desktop.
JavaScript
7
star
12

gnome-extension-development-utility

[email protected]
JavaScript
5
star
13

gnome-shell-extension-add-on-desktop

Add application launchers on your desktop.
JavaScript
4
star
14

Move-OSD-Windows-GNOME-Extension

A GNOME Shell extension allowing the user to set the position of the OSD windows for sound or luminosity.
JavaScript
2
star
15

gedit-plugin-panel-manager

This is a plugin for the Gedit text editor, giving an easy access to controls for hiding/showing Gedit panels.
Python
2
star
16

slightstone-server

Server part of the "Mini-Heartstone" university java project (project of "Algorithme, Conception et mise en Ε“uvre de logiciels")
Java
1
star
17

nautilus-launcher-creator

[NOT WORKING] A nautilus extension providing an advanced dialog in order to create a launcher (.desktop file) for any file.
Python
1
star
18

fortune-on-lockscreen

GNOME Shell extension showing a return of `fortune` on the lock screen
JavaScript
1
star
19

change-gdm-login-background

Script changing the login screen background with GDM3
Shell
1
star