{"id":14235403,"url":"https://github.com/jpfleury/gedit-markdown","last_synced_at":"2025-12-27T09:02:55.080Z","repository":{"id":21055487,"uuid":"24354611","full_name":"jpfleury/gedit-markdown","owner":"jpfleury","description":"Markdown support for the gedit text editor, with live preview and export tools","archived":false,"fork":false,"pushed_at":"2025-05-19T19:58:39.000Z","size":4249,"stargazers_count":131,"open_issues_count":2,"forks_count":29,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-08-11T00:38:55.819Z","etag":null,"topics":["gedit","gedit-plugin","gtk","html","markdown","markdown-editor","markdown-preview","markdown-viewer","python","shell","text-editor","webkit2"],"latest_commit_sha":null,"homepage":"","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/jpfleury.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-23T02:57:09.000Z","updated_at":"2025-05-19T19:58:43.000Z","dependencies_parsed_at":"2022-09-13T22:51:10.951Z","dependency_job_id":null,"html_url":"https://github.com/jpfleury/gedit-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jpfleury/gedit-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpfleury%2Fgedit-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpfleury%2Fgedit-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpfleury%2Fgedit-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpfleury%2Fgedit-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpfleury","download_url":"https://codeload.github.com/jpfleury/gedit-markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpfleury%2Fgedit-markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28076534,"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","status":"online","status_checked_at":"2025-12-27T02:00:05.897Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","gtk","html","markdown","markdown-editor","markdown-preview","markdown-viewer","python","shell","text-editor","webkit2"],"created_at":"2024-08-20T21:01:53.070Z","updated_at":"2025-12-27T09:02:55.038Z","avatar_url":"https://github.com/jpfleury.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"**Versions:**\n\n* For gedit 2 and gedit 3.0 to 3.6, see the [gedit-markdown v1 documentation](https://github.com/jpfleury/gedit-markdown/tree/v1#readme).\n* For gedit 3.8 to 3.12, see the [gedit-markdown v2 documentation](https://github.com/jpfleury/gedit-markdown/tree/v2#readme).\n* For gedit 3.28 to 3.38, see the [gedit-markdown v3 documentation](https://github.com/jpfleury/gedit-markdown/tree/v3#readme).\n* For gedit 41 and later, see the documentation below (gedit-markdown v4).\n\n## Overview\n\ngedit-markdown adds Markdown support to gedit, the default GNOME text editor.\n\nIt provides:\n\n* Markdown *snippets*\n* A *Markdown Preview* plugin for gedit, shown in the side or bottom panel, that renders the current document or selection in HTML\n* An *external tool* for exporting the current document or selection to HTML or PDF\n\n![Markdown Preview in gedit's side panel](https://raw.githubusercontent.com/jpfleury/gedit-markdown/master/doc/markdown-preview-side-panel.png)\n\n## Requirements\n\n* gedit-markdown v4 supports gedit 41 and later, and comes with an installer for GNU/Linux.\n* The *Markdown Preview* plugin requires the packages `python3-markdown` and `gir1.2-webkit2-4.0`.\n\n## Installation (or update)\n\n* [Download the gedit-markdown v4 archive.](https://github.com/jpfleury/gedit-markdown/archive/master.zip)\n* Extract the archive.\n* Open a terminal in the extracted folder.\n* Run the installer:\n\n\t\t./gedit-markdown.sh install\n\nMarkdown support will be installed for the current user (no root privileges needed). You can delete the extracted folder after installation.\n\n## Uninstallation\n\n* Open a terminal in the extracted folder.\n* Run the uninstaller:\n\n\t\t./gedit-markdown.sh uninstall\n\n## Usage\n\nFirst, restart gedit if it's already running.\n\n### Syntax highlighting\n\nSyntax highlighting should be automatically activated for files recognized as Markdown (extensions `.markdown`, `.md`, or `.mkd`). Otherwise, activate it manually via *View \u003e Highlight Mode \u003e Markup* and select *Markdown*.\n\n### Plugin *Markdown Preview*\n\nTo enable this plugin, go to *Edit \u003e Preferences \u003e Plugins* and check *Markdown Preview*.\n\nTwo items are added to the gedit *Tools* menu:\n\n* *Update Markdown Preview*: displays a preview of the current document or selection in the side panel or bottom panel.\n\n\tNote: There are two other ways to update the preview:\n\n\t - Using the keyboard shortcut *Ctrl+Alt+m* (can be changed in the configuration file)\n\t - Right-clicking in the preview area (side or bottom panel) and selecting *Update Preview*\n\n* *Toggle Markdown Preview visibility*: toggles the Markdown Preview panel tab.\n\n\tNote: The keyboard shortcut *Ctrl+Alt+v* (configurable) does the same.\n\nWhen right-clicking in the preview area, a context menu appears with several options. Besides the default ones (previous page, next page, copy, etc.), it includes:\n\n* *Update Preview*: reloads the preview of the current document or selection in the side or bottom panel.\n\nLocal files will be opened in the preview area, while external files will be opened in your default web browser.\n\nHere's a screenshot of the plugin in the bottom panel:\n\n![Markdown Preview in gedit's bottom panel](https://raw.githubusercontent.com/jpfleury/gedit-markdown/master/doc/markdown-preview-bottom-panel.png)\n\n### Table of contents\n\nWhen the `toc` Markdown extension is enabled (see *Configuration file*; enabled by default), add `[TOC]` to your Markdown source to generate a clickable table of contents.\n\n### Snippets\n\nTo use Markdown snippets, activate the *Snippets* plugin via *Edit \u003e Preferences \u003e Plugins*. Then go to *Tools \u003e Manage Snippets...* to explore the options.\n\n### Converters (external tools)\n\nThe following tools are included:\n\n* Export to HTML\n* Export to PDF\n\nTo use an external tool, activate the *External Tools* plugin via *Edit \u003e Preferences \u003e Plugins*. Then go to *Tools \u003e External Tools \u003e Export to HTML* to run it. The shortcut *Ctrl+Alt+h* does the same. The content of the current Markdown file or selection will be converted to HTML or PDF, and the result opened in a new document.\n\nTo edit the tool, go to *Tools \u003e Manage External Tools...*.\n\n### Configuration file\n\nThe configuration file is located at:\n\n\t$XDG_CONFIG_HOME/gedit/gedit-markdown.ini\n\nThis usually corresponds to:\n\n\t$HOME/.config/gedit/gedit-markdown.ini\n\nThe `[markdown-preview]` section contains several properties:\n\n* `panel`: position of the preview. Possible values: `bottom` (default) or `side`.\n* `shortcut`: shortcut to refresh the preview. Default: `\u003cControl\u003e\u003cAlt\u003em`.\n* `extensions`: a list separated by spaces of [Markdown extensions](https://python-markdown.github.io/extensions/#officially-supported-extensions). Default: `extra toc`.\n* `visibility`: whether to show the Markdown Preview panel tab at startup. Values: `0` (hidden) or `1` (shown; default).\n* `visibilityShortcut`: shortcut to toggle visibility. Default: `\u003cControl\u003e\u003cAlt\u003ev`.\n* `autoIdle`: idle time before updating the preview (ms). Values: `0` (immediate), `250` (default), or any positive float.\n* `autoReloadActivate`: reload preview when plugin is activated. `0` (off) or `1` (on; default).\n* `autoReloadOpen`: reload preview when document is opened. `0` (off) or `1` (on; default).\n* `autoReloadSave`: reload preview on save. `0` (off) or `1` (on; default).\n* `autoReloadTabs`: reload preview on tab switch. `0` (off) or `1` (on; default).\n* `autoReloadEdit`: reload preview on edit. `0` (off) or `1` (on; default).\n* `autoReloadSelection`: reload preview on selection change. `0` (off; default) or `1` (on).\n\nIf the file or any property is missing, default values will be generated on startup.\n\n### Markdown demo\n\n* [Demo 1](doc/demo-markdown.md)\n* [Demo 2](doc/demo-markdown-extra.md)\n\n## Details and limitations\n\n* Syntax highlighting and snippets for standard Markdown were officially added in GtkSourceView and gedit \u003e 3.1.1.\n\n* Older versions of gedit-markdown also added a custom Markdown MIME type and support for the `.mdtxt` extension. Since Markdown support was added to `shared-mime-info` ([see the bug report](https://bugs.freedesktop.org/show_bug.cgi?id=27441)), gedit-markdown no longer provides its own MIME type. For compliance, `.mdtxt` is no longer supported.\n\n* Since HTML code can be embedded in Markdown, HTML highlighting was added. However, Markdown inside HTML blocks (e.g., `\u003cdiv\u003e`) or Markdown Extra inside HTML blocks without the `markdown=\"1\"` attribute is not processed, even if highlighted.\n\n* Inline code spans are wrapped in backticks. Markdown allows using any number of matching backticks as long as the same number isn't inside the text. Examples:\n\n\t\t`lorem lorem lorem lorem`\n\t\t\n\t\t`lorem lorem `` lorem lorem`\n\t\t\n\t\t`lorem lorem ````` lorem lorem`\n\t\t\n\t\t``lorem lorem lorem lorem``\n\t\t\n\t\t``lorem lorem ` lorem lorem``\n\t\t\n\t\t``lorem lorem ````` lorem lorem``\n\n\tSyntax highlighting in gedit supports up to two backticks.\n\n* Blockquotes can contain both inline and block elements, but only inline ones (e.g., emphasis, links) are highlighted.\n\n* Full context analysis is not possible (regex can't span multiple lines). As a result:\n\n\t* Multiple paragraphs in a list item must be indented. For example:\n\n\t\t\t- Item A (paragraph 1).\n\n\t\t\t\tItem A (paragraph 2).\n\n\t\t\t\tItem A (paragraph 3).\n\n\t\t\t- Item B.\n\n\t\tThere's a conflict between indented list content and indented code blocks. The choice was made to only highlight code blocks from two indentation levels.\n\n\t* Only the underline of Setext-style headers is matched, so it may not truly indicate a title.\n\n\t* Some Markdown Extra elements are highlighted even if the context is incorrect: Setext header IDs, colons in definition lists, and table separators.\n\n## Development\n\nGit is used for version control. [Browse or clone the repository here.](https://github.com/jpfleury/gedit-markdown)\n\n### Localization\n\nThe *Markdown Preview* plugin is localizable. Strings are in `plugins/markdown-preview/locale/markdown-preview.pot`.\n\n## License\n\nMaintainer: Jean-Philippe Fleury  \nCopyright © 2009-2014, 2025 Jean-Philippe Fleury \u003chttps://github.com/jpfleury\u003e  \nCopyright © 2018, 2020 darkdragon-001 \u003chttps://github.com/darkdragon-001\u003e  \nCopyright © 2005, 2006 Michele Campeotto \u003cmicampe@micampe.it\u003e\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpfleury%2Fgedit-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpfleury%2Fgedit-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpfleury%2Fgedit-markdown/lists"}