{"id":16646697,"url":"https://github.com/maoschanz/gedit-plugin-markdown_preview","last_synced_at":"2025-03-16T22:31:50.882Z","repository":{"id":33990022,"uuid":"124969903","full_name":"maoschanz/gedit-plugin-markdown_preview","owner":"maoschanz","description":"A gedit plugin previewing markdown (.md) documents","archived":false,"fork":false,"pushed_at":"2024-02-25T02:44:54.000Z","size":544,"stargazers_count":133,"open_issues_count":18,"forks_count":15,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-02-27T15:03:44.826Z","etag":null,"topics":["gedit","gedit-plugin","gnome","gnome-desktop","markdown","pandoc","pandoc-markdown"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maoschanz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-03-13T00:44:07.000Z","updated_at":"2025-01-05T15:50:57.000Z","dependencies_parsed_at":"2023-12-28T18:30:13.492Z","dependency_job_id":null,"html_url":"https://github.com/maoschanz/gedit-plugin-markdown_preview","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoschanz%2Fgedit-plugin-markdown_preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoschanz%2Fgedit-plugin-markdown_preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoschanz%2Fgedit-plugin-markdown_preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maoschanz%2Fgedit-plugin-markdown_preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maoschanz","download_url":"https://codeload.github.com/maoschanz/gedit-plugin-markdown_preview/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243832255,"owners_count":20355074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gedit","gedit-plugin","gnome","gnome-desktop","markdown","pandoc","pandoc-markdown"],"created_at":"2024-10-12T08:42:50.643Z","updated_at":"2025-03-16T22:31:50.615Z","avatar_url":"https://github.com/maoschanz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Gedit Markdown Preview\n\nThis is a plugin for the Gedit text editor, previewing .md files in the side\npane (\u003ckbd\u003eF9\u003c/kbd\u003e) or the bottom (\u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eF9\u003c/kbd\u003e) pane.\n\n\u003c!-- TODO\n\nhttps://docs.gtk.org/gtk3/text-widget-overview.html\n\nPour la release 4.0 :\n\n- [ ] merger le mec qui m'a fait un scroll dymanique\n- à réparer :\n\t- [ ] `gtk_widget_get_scale_factor` ???\n- à changer :\n\t- [ ] pourquoi un CDATA ?\n\t- [ ] autoriser la suppression des shortcuts\n\t- [ ] valeurs par défaut des shortcuts ?\n- à terminer :\n\t- [ ] \"remove tags\" action\n- à faire :\n\t- [ ] retenir le scroll et le numéro de page à l'échelle de la gedit.view\n\t- [ ] si le boug scrolle à la fin, reproduire ça au reload\n- [ ] numéro de version etc.\n\nPour la release 5.0 :\n\n- à faire :\n\t- [ ] essayer de faire de l'auto-scrolling en mode 'whole' en faisant des\n\tsélecteurs un peu dégueulasses (qui visent les titres ? ou les paragraphes ?\n\ton peut faire évoluer plus tard certes)\n\t- [ ] ...\n- à terminer :\n\t- [ ] revealjs\n- [ ] numéro de version etc.\n\n---\n\nPour un moment indéterminé :\n\n- [~] différencier explicitement le chemin d'exécution pour l'ouverture d'un\n      fichier (reconnaissance format etc.) d'un reload normal\n\t- [ ] si un doc est ouvert et que c'est désac et qu'on active, ça ne réagit\n\t      pas et on ne peut pas recharger\n- reveal js https://github.com/jgm/pandoc/wiki/Using-pandoc-to-produce-reveal.js-slides\n\t- [ ] prefs\n\t\t- [ ] rendu fonctionnel\n\t\t- [ ] transitions\n\t\t- [ ] numéros de pages\n\t\t- [ ] paramètres de thème\n\t- [ ] export\n\t\t- [ ] ne pas désactiver l'entrée quand on exporte\n\t\t- [ ] rendu fonctionnel\n\t\t- [ ] transitions\n\t\t- [ ] numéros de pages\n\t\t- [ ] paramètres de thème\n- [ ] CSS for admonitions (and other default plugins ?)\n\t- [ ] and pymdown ??\n\n~     TODO --\u003e\n\n### Previewing\n\n- show a preview of a file\n- dynamically update the preview\n- zoom in or out on the preview\n- search in the preview\n- open links and images\n\nThis works for Markdown, HTML, and SVG files.\n\n### Exporting\n\nYou can print the preview, or export it:\n\n- if [`pandoc`](https://pandoc.org/) is installed on your system, you can export to any format it supports\n\t- a stylesheet can be applied to most file formats\n\t- be careful if you want to export to PDF: pandoc doesn't come with all necessary dependencies by default\n- if only `python3-markdown` is installed, you can export to HTML\n\t- a stylesheet can be applied\n\t- `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/)\n\n### Editing assistance\n\n- insert an image in your file\n- insert markdown tags in your text from the right-click menu\n\u003c!--- insert markdown tags in your text with keyboard shortcuts--\u003e\n\n---\n\n## Screenshots\n\n| With the preview in the side pane, menu opened | With the preview in the bottom pane, searching |\n|------|------|\n| ![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) |\n\n---\n\n## Installation\n\n### Packages\n\n- For Arch Linux and its derivatives: the [AUR](https://aur.archlinux.org/packages/gedit-plugin-markdown_preview) package is named `gedit-plugin-markdown_preview`.\n\nEven if you install the plugin with a package manager, you may like to read the\nfollowing sections, since installing optional dependencies will enable new\nfeatures of the plugin.\n\n### Manual installation\n\n1. Dependencies. Be sure to have these packages before installing the plugin:\n  - `gedit` (≥3.22)\n  - `gir1.2-webkit2-4.0`\n  - `python3-markdown` or `pandoc`\n  - if you want to export to PDF with pandoc, you'll need at least `pdflatex`\n    and `lmodern`. Those are provided by `texlive` packages whose names vary\n    depending on the distribution. Warning: the version provided by Debian is\n    sadly broken (some error message about *xcolor.sty*).\n  - `libglib2.0-bin` (needed for the installation script only). This is the\n    package name on debian-based distros, it may differ on your system.\n2. Download the ZIP of [the last release](https://github.com/maoschanz/gedit-plugin-markdown_preview/releases).\n3. Extract the archive.\n4. Open the project's folder in a terminal.\n5. Run `./install.sh` — it can be executed as root (system-wide installation) or\n   as a normal user (user-wide installation).\n\n## Activation\n\nThe plugin is now installed and has to be enabled:\n\n- Open Gedit's preferences.\n- Go to the \"Plugins\" tab.\n- Enable the \"Markdown Preview\" plugin.\n\n---\n\n## Configuration\n\nThe plugin's options can be accessed…\n\n- from Gedit's preferences → Plugins → Markdown preview → Preferences\n- or with the plugin's \"3-dots menu\" → Options\n\n### General options\n\n- Position of the preview (left side or bottom)\n- 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)\n\n### Rendering options\n\nThe preview can be generated with [pandoc](https://pandoc.org/) or\n[python-markdown](https://python-markdown.github.io/).\n\nA stylesheet (CSS file) can be applied to the preview (markdown files only, it\nwill not be loaded for HTML files).\n\n##### Options with python-markdown\n\nA set of [extensions](https://python-markdown.github.io/extensions/) is provided\nnatively with python-markdown. You can enable or disable them depending on your\nneeds.\n\n[Great third-party extensions](https://facelessuser.github.io/pymdown-extensions/)\nexist too, and once installed they can be added manually to the list.\n\n\u003c!-- ##### Options with pandoc --\u003e\n\n\u003c!-- You can decide to render the file: --\u003e\n\n\u003c!-- - directly as HTML (it may then use the CSS file you set); --\u003e\n\u003c!--- or as HTML with the stylesheet and javascript code from _revealjs_, to preview--\u003e\n\u003c!--the file as a slideshow, which comes with pre-defined themes and slide--\u003e\n\u003c!--transition types. (**WORK IN PROGRESS**);--\u003e\n\u003c!--- or following what you write as the \"custom\" option: be sure to write a full--\u003e\n\u003c!--correct command whose output will be HTML code, and press \"Remember\" to save--\u003e\n\u003c!--your custom command. (**WORK IN PROGRESS**)--\u003e\n\n\u003c!-- ### Keyboard shortcuts --\u003e\n\n\u003c!-- Customize keyboard shortcuts to add/remove tags (**WORK IN PROGRESS**) --\u003e\n\n---\n\n## Available languages\n\n- English\n- French\n- Dutch\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaoschanz%2Fgedit-plugin-markdown_preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaoschanz%2Fgedit-plugin-markdown_preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaoschanz%2Fgedit-plugin-markdown_preview/lists"}