├── .gitignore ├── COPYING ├── Makefile ├── README.md ├── config └── template.html ├── doc ├── demo-markdown-extra.md ├── demo-markdown.md ├── exemple1.png ├── exemple3.png ├── exemple4-grand.png ├── exemple4-petit.png ├── exemple5.png ├── markdown-preview-bottom-panel.png └── markdown-preview-side-panel.png ├── gedit-markdown.sh ├── plugins └── markdown-preview │ ├── markdown-preview.plugin │ └── markdown-preview │ ├── __init__.py │ └── locale │ ├── de │ └── LC_MESSAGES │ │ └── markdown-preview.po │ ├── fr │ └── LC_MESSAGES │ │ └── markdown-preview.po │ └── markdown-preview.pot ├── snippets └── markdown.xml └── tools ├── export-to-html └── export-to-pdf /.gitignore: -------------------------------------------------------------------------------- 1 | /archives/ 2 | __pycache__/ 3 | *.mo 4 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | LOCALEDIR = plugins/markdown-preview/markdown-preview/locale 2 | INITPY = plugins/markdown-preview/markdown-preview/__init__.py 3 | 4 | clean-pot: 5 | rm -f "$(LOCALEDIR)/markdown-preview.pot" 6 | touch "$(LOCALEDIR)/markdown-preview.pot" 7 | 8 | pot: clean-pot 9 | xgettext -j -o "$(LOCALEDIR)/markdown-preview.pot" -L Python "$(INITPY)" 10 | 11 | po: pot 12 | for po in $(shell find "$(LOCALEDIR)" -name '*.po'); do \ 13 | msgmerge -o tempo "$$po" "$(LOCALEDIR)/markdown-preview.pot"; \ 14 | rm "$$po"; \ 15 | mv tempo "$$po"; \ 16 | done 17 | 18 | mo: 19 | for po in $(shell find "$(LOCALEDIR)" -name '*.po'); do \ 20 | msgfmt -o "$${po%.*}.mo" "$$po"; \ 21 | done 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | **Versions:** 2 | 3 | * 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). 4 | * For gedit 3.8 to 3.12, see the [gedit-markdown v2 documentation](https://github.com/jpfleury/gedit-markdown/tree/v2#readme). 5 | * For gedit 3.28 to 3.38, see the [gedit-markdown v3 documentation](https://github.com/jpfleury/gedit-markdown/tree/v3#readme). 6 | * For gedit 41 and later, see the documentation below (gedit-markdown v4). 7 | 8 | ## Overview 9 | 10 | gedit-markdown adds Markdown support to gedit, the default GNOME text editor. 11 | 12 | It provides: 13 | 14 | * Markdown *snippets* 15 | * A *Markdown Preview* plugin for gedit, shown in the side or bottom panel, that renders the current document or selection in HTML 16 | * An *external tool* for exporting the current document or selection to HTML or PDF 17 | 18 | ![Markdown Preview in gedit's side panel](https://raw.githubusercontent.com/jpfleury/gedit-markdown/master/doc/markdown-preview-side-panel.png) 19 | 20 | ## Requirements 21 | 22 | * gedit-markdown v4 supports gedit 41 and later, and comes with an installer for GNU/Linux. 23 | * The *Markdown Preview* plugin requires the packages `python3-markdown` and `gir1.2-webkit2-4.0`. 24 | 25 | ## Installation (or update) 26 | 27 | * [Download the gedit-markdown v4 archive.](https://github.com/jpfleury/gedit-markdown/archive/master.zip) 28 | * Extract the archive. 29 | * Open a terminal in the extracted folder. 30 | * Run the installer: 31 | 32 | ./gedit-markdown.sh install 33 | 34 | Markdown support will be installed for the current user (no root privileges needed). You can delete the extracted folder after installation. 35 | 36 | ## Uninstallation 37 | 38 | * Open a terminal in the extracted folder. 39 | * Run the uninstaller: 40 | 41 | ./gedit-markdown.sh uninstall 42 | 43 | ## Usage 44 | 45 | First, restart gedit if it's already running. 46 | 47 | ### Syntax highlighting 48 | 49 | Syntax highlighting should be automatically activated for files recognized as Markdown (extensions `.markdown`, `.md`, or `.mkd`). Otherwise, activate it manually via *View > Highlight Mode > Markup* and select *Markdown*. 50 | 51 | ### Plugin *Markdown Preview* 52 | 53 | To enable this plugin, go to *Edit > Preferences > Plugins* and check *Markdown Preview*. 54 | 55 | Two items are added to the gedit *Tools* menu: 56 | 57 | * *Update Markdown Preview*: displays a preview of the current document or selection in the side panel or bottom panel. 58 | 59 | Note: There are two other ways to update the preview: 60 | 61 | - Using the keyboard shortcut *Ctrl+Alt+m* (can be changed in the configuration file) 62 | - Right-clicking in the preview area (side or bottom panel) and selecting *Update Preview* 63 | 64 | * *Toggle Markdown Preview visibility*: toggles the Markdown Preview panel tab. 65 | 66 | Note: The keyboard shortcut *Ctrl+Alt+v* (configurable) does the same. 67 | 68 | When 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: 69 | 70 | * *Update Preview*: reloads the preview of the current document or selection in the side or bottom panel. 71 | 72 | Local files will be opened in the preview area, while external files will be opened in your default web browser. 73 | 74 | Here's a screenshot of the plugin in the bottom panel: 75 | 76 | ![Markdown Preview in gedit's bottom panel](https://raw.githubusercontent.com/jpfleury/gedit-markdown/master/doc/markdown-preview-bottom-panel.png) 77 | 78 | ### Table of contents 79 | 80 | When 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. 81 | 82 | ### Snippets 83 | 84 | To use Markdown snippets, activate the *Snippets* plugin via *Edit > Preferences > Plugins*. Then go to *Tools > Manage Snippets...* to explore the options. 85 | 86 | ### Converters (external tools) 87 | 88 | The following tools are included: 89 | 90 | * Export to HTML 91 | * Export to PDF 92 | 93 | To use an external tool, activate the *External Tools* plugin via *Edit > Preferences > Plugins*. Then go to *Tools > External Tools > 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. 94 | 95 | To edit the tool, go to *Tools > Manage External Tools...*. 96 | 97 | ### Configuration file 98 | 99 | The configuration file is located at: 100 | 101 | $XDG_CONFIG_HOME/gedit/gedit-markdown.ini 102 | 103 | This usually corresponds to: 104 | 105 | $HOME/.config/gedit/gedit-markdown.ini 106 | 107 | The `[markdown-preview]` section contains several properties: 108 | 109 | * `panel`: position of the preview. Possible values: `bottom` (default) or `side`. 110 | * `shortcut`: shortcut to refresh the preview. Default: `m`. 111 | * `extensions`: a list separated by spaces of [Markdown extensions](https://python-markdown.github.io/extensions/#officially-supported-extensions). Default: `extra toc`. 112 | * `visibility`: whether to show the Markdown Preview panel tab at startup. Values: `0` (hidden) or `1` (shown; default). 113 | * `visibilityShortcut`: shortcut to toggle visibility. Default: `v`. 114 | * `autoIdle`: idle time before updating the preview (ms). Values: `0` (immediate), `250` (default), or any positive float. 115 | * `autoReloadActivate`: reload preview when plugin is activated. `0` (off) or `1` (on; default). 116 | * `autoReloadOpen`: reload preview when document is opened. `0` (off) or `1` (on; default). 117 | * `autoReloadSave`: reload preview on save. `0` (off) or `1` (on; default). 118 | * `autoReloadTabs`: reload preview on tab switch. `0` (off) or `1` (on; default). 119 | * `autoReloadEdit`: reload preview on edit. `0` (off) or `1` (on; default). 120 | * `autoReloadSelection`: reload preview on selection change. `0` (off; default) or `1` (on). 121 | 122 | If the file or any property is missing, default values will be generated on startup. 123 | 124 | ### Markdown demo 125 | 126 | * [Demo 1](doc/demo-markdown.md) 127 | * [Demo 2](doc/demo-markdown-extra.md) 128 | 129 | ## Details and limitations 130 | 131 | * Syntax highlighting and snippets for standard Markdown were officially added in GtkSourceView and gedit > 3.1.1. 132 | 133 | * 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. 134 | 135 | * Since HTML code can be embedded in Markdown, HTML highlighting was added. However, Markdown inside HTML blocks (e.g., `
`) or Markdown Extra inside HTML blocks without the `markdown="1"` attribute is not processed, even if highlighted. 136 | 137 | * 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: 138 | 139 | `lorem lorem lorem lorem` 140 | 141 | `lorem lorem `` lorem lorem` 142 | 143 | `lorem lorem ````` lorem lorem` 144 | 145 | ``lorem lorem lorem lorem`` 146 | 147 | ``lorem lorem ` lorem lorem`` 148 | 149 | ``lorem lorem ````` lorem lorem`` 150 | 151 | Syntax highlighting in gedit supports up to two backticks. 152 | 153 | * Blockquotes can contain both inline and block elements, but only inline ones (e.g., emphasis, links) are highlighted. 154 | 155 | * Full context analysis is not possible (regex can't span multiple lines). As a result: 156 | 157 | * Multiple paragraphs in a list item must be indented. For example: 158 | 159 | - Item A (paragraph 1). 160 | 161 | Item A (paragraph 2). 162 | 163 | Item A (paragraph 3). 164 | 165 | - Item B. 166 | 167 | There's a conflict between indented list content and indented code blocks. The choice was made to only highlight code blocks from two indentation levels. 168 | 169 | * Only the underline of Setext-style headers is matched, so it may not truly indicate a title. 170 | 171 | * Some Markdown Extra elements are highlighted even if the context is incorrect: Setext header IDs, colons in definition lists, and table separators. 172 | 173 | ## Development 174 | 175 | Git is used for version control. [Browse or clone the repository here.](https://github.com/jpfleury/gedit-markdown) 176 | 177 | ### Localization 178 | 179 | The *Markdown Preview* plugin is localizable. Strings are in `plugins/markdown-preview/locale/markdown-preview.pot`. 180 | 181 | ## License 182 | 183 | Maintainer: Jean-Philippe Fleury 184 | Copyright © 2009-2014, 2025 Jean-Philippe Fleury 185 | Copyright © 2018, 2020 darkdragon-001 186 | Copyright © 2005, 2006 Michele Campeotto 187 | 188 | This program is free software: you can redistribute it and/or modify 189 | it under the terms of the GNU General Public License as published by 190 | the Free Software Foundation, either version 3 of the License, or 191 | (at your option) any later version. 192 | 193 | This program is distributed in the hope that it will be useful, 194 | but WITHOUT ANY WARRANTY; without even the implied warranty of 195 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 196 | GNU General Public License for more details. 197 | 198 | You should have received a copy of the GNU General Public License 199 | along with this program. If not, see . 200 | -------------------------------------------------------------------------------- /config/template.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | %s 8 | -------------------------------------------------------------------------------- /doc/demo-markdown-extra.md: -------------------------------------------------------------------------------- 1 | Titre de style Setext avec un attribut `id` {#idTitre1} 2 | =========================================== 3 | 4 | **Contents** 5 | 6 | [TOC] 7 | 8 | ## Titre de style atx avec un attribut `id` ## {#idTitre2} 9 | 10 | Les barres de soulignement ne génèrent plus d'emphase à l'intérieur d'un mot: 11 | 12 | - Le nom du fichier est «mon_fichier_texte.txt». 13 | - Le nom du fichier est «mon__fichier__texte.txt». 14 | 15 | Pour les autres contextes, l'emphase est encore générée: 16 | 17 | - J'utilise _Markdown Extra_. 18 | - J'utilise __Markdown Extra__. 19 | 20 | Voici une liste de définitions: 21 | 22 | Mot 1 23 | : définition 24 | Mot 2 25 | : définition 26 | 27 | Voici maintenant un bloc de code balisé: 28 | 29 | ~~~ 30 | Code HTML affiché 31 | sans être interprété. 32 | ~~~ 33 | 34 | Markdown Extra permet de préciser des abréviations, par exemple: 35 | 36 | *[bac]: baccalauréat 37 | *[HTML]: Hypertext Markup Language 38 | 39 | Toutes les occurrences de «bac» et «HTML» trouvées dans le texte seront marquées pour permettre l'affichage de la définition lors du passage du curseur. 40 | 41 | Voici maintenant une phrase contenant un lien vers une note de bas de page[^1]. 42 | 43 | Les tableaux sont également supportés: 44 | 45 | | Titre de tableau 1 | Titre de tableau 2 | 46 | | ------------------ | ------------------ | 47 | | Cellule | Cellule | 48 | | Cellule | Cellule | 49 | 50 | La note de bas de page créée un peu plus haut peut être définie n'importe où dans le texte, par exemple ici: 51 | 52 | [^1]: Voici la note de bas de page. 53 | 54 | Enfin, deux nouveaux caractères peuvent être échappés: le deux-points (\:) et la barre verticale (\|). 55 | -------------------------------------------------------------------------------- /doc/demo-markdown.md: -------------------------------------------------------------------------------- 1 | Titre de niveau 1 (style Setext) 2 | ================================ 3 | 4 | ## Titre de niveau 2 (style atx) 5 | 6 | ### Titre de niveau 3 (style atx) ### 7 | 8 | Il est possible d'utiliser une *emphase légère* ou une **emphase forte**. Continuons avec un retour à la ligne 9 | forcé. Voici maintenant du `code en ligne`. On peut également échapper des caractères, par exemple \`ceci n'est pas du code, car les accents graves sont échappés\`. 10 | 11 | N'oublions pas que du code HTML peut être inséré directement dans un document Markdown. 12 | 13 | Voici à présent une liste non ordonnée: 14 | 15 | - Item de liste non ordonnée créé avec le symbole `-` 16 | + Item de liste non ordonnée créé avec le symbole `+` 17 | * Item de liste non ordonnée créé avec le symbole `*` 18 | 19 | Pour sa part, une liste ordonnée ressemble à ceci: 20 | 21 | 1. Item de liste ordonnée 22 | 23 | 2. Item de liste ordonnée contenant un bloc de code: 24 | 25 | Code HTML affiché 26 | sans être interprété. 27 | 28 | 3. Item de liste ordonnée continuant sur un autre paragraphe: 29 | 30 | Suite de l'item. 31 | 32 | Un autre élément qui peut être utilisé est la citation: 33 | 34 | > Voici une citation, un peu comme dans les **courriels**. 35 | >> On peut également ajouter *plusieurs niveaux de citation*. 36 | 37 | Ajoutons des lignes horizontales: 38 | 39 | ---------- 40 | ** ** ** ** ** 41 | __ __ __ __ __ 42 | 43 | Les liens ont aussi leur syntaxe: 44 | 45 | - Lien automatique: 46 | 47 | - Lien incorporé au texte: le logiciel [gedit-markdown](https://github.com/jpfleury/gedit-markdown "Attribut title optionnel") permet d'ajouter le support du langage Markdown dans l'éditeur de texte gedit. 48 | 49 | - Lien par référence: le logiciel [gedit-markdown][1] permet entre autres d'utiliser la coloration syntaxique du Markdown dans gedit. 50 | 51 | - Autre lien par référence: le logiciel [gedit-markdown] permet entre autres d'utiliser la coloration syntaxique du Markdown dans gedit. 52 | 53 | Il ne faudrait pas oublier les images: 54 | 55 | - Image incorporée au texte: le logo de Wikipédia est ![Wikipedia](http://upload.wikimedia.org/wikipedia/commons/5/5a/Wikipedia-logo-v2-fr.png) 56 | 57 | - Image par référence: le logo de Wikipédia est ![Wikipedia][logo wikipedia] 58 | 59 | Les liens par référence créés un peu plus haut peuvent être définis n'importe où dans le texte, par exemple ici: 60 | 61 | [1]: https://github.com/jpfleury/gedit-markdown 62 | [gedit-markdown]: https://github.com/jpfleury/gedit-markdown 63 | 64 | Même chose en ce qui concerne l'image par référence: 65 | 66 | [logo wikipedia]: http://upload.wikimedia.org/wikipedia/commons/5/5a/Wikipedia-logo-v2-fr.png "Attribut title optionnel" 67 | -------------------------------------------------------------------------------- /doc/exemple1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jpfleury/gedit-markdown/f931e42d554cab1ab90bfbaf4f0a7fbc091dd9f6/doc/exemple1.png -------------------------------------------------------------------------------- /doc/exemple3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jpfleury/gedit-markdown/f931e42d554cab1ab90bfbaf4f0a7fbc091dd9f6/doc/exemple3.png -------------------------------------------------------------------------------- /doc/exemple4-grand.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jpfleury/gedit-markdown/f931e42d554cab1ab90bfbaf4f0a7fbc091dd9f6/doc/exemple4-grand.png -------------------------------------------------------------------------------- /doc/exemple4-petit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jpfleury/gedit-markdown/f931e42d554cab1ab90bfbaf4f0a7fbc091dd9f6/doc/exemple4-petit.png -------------------------------------------------------------------------------- /doc/exemple5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jpfleury/gedit-markdown/f931e42d554cab1ab90bfbaf4f0a7fbc091dd9f6/doc/exemple5.png -------------------------------------------------------------------------------- /doc/markdown-preview-bottom-panel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jpfleury/gedit-markdown/f931e42d554cab1ab90bfbaf4f0a7fbc091dd9f6/doc/markdown-preview-bottom-panel.png -------------------------------------------------------------------------------- /doc/markdown-preview-side-panel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jpfleury/gedit-markdown/f931e42d554cab1ab90bfbaf4f0a7fbc091dd9f6/doc/markdown-preview-side-panel.png -------------------------------------------------------------------------------- /gedit-markdown.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This file is part of gedit-markdown. 4 | # Author: Jean-Philippe Fleury 5 | # Copyright © 2009 Jean-Philippe Fleury 6 | 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | ################################################################################ 21 | ## @title Setup 22 | ################################################################################ 23 | 24 | set -euo pipefail 25 | trap 'echo "Error on line $LINENO: $BASH_COMMAND" >&2' ERR 26 | trap 'exit 1' INT TERM 27 | 28 | ################################################################################ 29 | ## @title Functions 30 | ################################################################################ 31 | 32 | is_empty_dir() { 33 | local dir=$1 34 | 35 | # -------------------- 36 | 37 | # Return false if: 38 | # - not a directory, or 39 | # - not readable (we can't test its contents), or 40 | # - is a symlink 41 | if [[ ! -d $dir || ! -r $dir || -L $dir ]]; then 42 | return 1 43 | fi 44 | 45 | # Subshell to avoid changing the global shopt state 46 | if ( 47 | shopt -s nullglob dotglob 48 | declare -a files 49 | files=("$dir"/*) 50 | (( ${#files[@]} == 0 )) 51 | ); then 52 | return 0 53 | fi 54 | 55 | return 1 56 | } 57 | 58 | remove_empty_dirs() { 59 | local dir parent 60 | 61 | # -------------------- 62 | 63 | for dir in "$@"; do 64 | while is_empty_dir "$dir"; do 65 | rmdir -v "$dir" || break 66 | 67 | parent=$(dirname -- "$dir") 68 | 69 | [[ $parent == "$dir" || $parent == / ]] && break 70 | 71 | dir=$parent 72 | done 73 | done 74 | } 75 | 76 | remove_plugin() { 77 | local file 78 | declare -a files_to_remove 79 | declare -a empty_dirs_to_remove 80 | 81 | # -------------------- 82 | 83 | # Files 84 | ####### 85 | 86 | files_to_remove=( 87 | "$PATH_SNIPPETS_GEDIT/markdown.xml" 88 | "$PATH_TOOLS_GEDIT/export-to-html" 89 | "$PATH_TOOLS_GEDIT/export-to-pdf" 90 | "$PATH_PLUGINS_GEDIT/markdown-preview.plugin" 91 | 92 | # Obsolete 93 | "$PATH_CONFIG_GEDIT/gedit-markdown.ini" 94 | "$PATH_PLUGINS_GEDIT/markdown-preview.gedit-plugin" 95 | ) 96 | 97 | for file in "${files_to_remove[@]}"; do 98 | if [[ ! -e $file ]]; then 99 | echo "File not found: $file" 100 | 101 | continue 102 | fi 103 | 104 | if [[ ! -f $file || -L $file ]]; then 105 | echo "Ignoring file: $file" 106 | 107 | continue 108 | fi 109 | 110 | rm -v "$file" 111 | done 112 | 113 | # Directories 114 | ############# 115 | 116 | empty_dirs_to_remove=( 117 | "$PATH_CONFIG" 118 | "$PATH_PLUGINS_GEDIT" 119 | "$PATH_PLUGIN_MARKDOWN_PREVIEW" 120 | "$PATH_SNIPPETS_GEDIT" 121 | "$PATH_TOOLS_GEDIT" 122 | ) 123 | 124 | if [[ ! -e $PATH_CONFIG ]]; then 125 | echo "Directory not found: $PATH_CONFIG" 126 | elif [[ ! -d $PATH_CONFIG || -L $PATH_CONFIG ]]; then 127 | echo "Ignoring directory: $PATH_CONFIG" 128 | else 129 | rm -rv "$PATH_CONFIG" 130 | fi 131 | 132 | if [[ ! -e $PATH_PLUGIN_MARKDOWN_PREVIEW ]]; then 133 | echo "Directory not found: $PATH_PLUGIN_MARKDOWN_PREVIEW" 134 | elif [[ ! -d $PATH_PLUGIN_MARKDOWN_PREVIEW || -L $PATH_PLUGIN_MARKDOWN_PREVIEW ]]; then 135 | echo "Ignoring directory: $PATH_PLUGIN_MARKDOWN_PREVIEW" 136 | else 137 | rm -rv "$PATH_PLUGIN_MARKDOWN_PREVIEW" 138 | fi 139 | 140 | remove_empty_dirs "${empty_dirs_to_remove[@]}" 141 | } 142 | 143 | ################################################################################ 144 | ## @title Constants 145 | ################################################################################ 146 | 147 | # gedit 148 | ####### 149 | 150 | PATH_CONFIG_GEDIT=${XDG_CONFIG_HOME:-$HOME/.config}/gedit 151 | PATH_SNIPPETS_GEDIT=$PATH_CONFIG_GEDIT/snippets 152 | PATH_TOOLS_GEDIT=$PATH_CONFIG_GEDIT/tools 153 | 154 | PATH_DATA_GEDIT=${XDG_DATA_HOME:-$HOME/.local/share}/gedit 155 | PATH_PLUGINS_GEDIT=$PATH_DATA_GEDIT/plugins 156 | 157 | declare -r PATH_CONFIG_GEDIT PATH_SNIPPETS_GEDIT PATH_TOOLS_GEDIT 158 | declare -r PATH_DATA_GEDIT PATH_PLUGINS_GEDIT 159 | 160 | # gedit-markdown 161 | ################ 162 | 163 | PATH_CONFIG=$PATH_CONFIG_GEDIT/markdown-preview 164 | 165 | PATH_PLUGIN_MARKDOWN_PREVIEW=$PATH_PLUGINS_GEDIT/markdown-preview 166 | 167 | declare -r PATH_CONFIG PATH_PLUGIN_MARKDOWN_PREVIEW 168 | 169 | ################################################################################ 170 | ## @title Arguments 171 | ################################################################################ 172 | 173 | action=${1:-} 174 | 175 | ################################################################################ 176 | ## @title Script 177 | ################################################################################ 178 | 179 | cd "$(dirname "$0")" || { echo >&2 "Can't access $0"; exit 1; } 180 | 181 | if [[ $action == install ]]; then 182 | echo "# gedit-markdown install" 183 | echo "########################" 184 | echo 185 | 186 | # In case this is an update 187 | ########################### 188 | 189 | echo "Removing previous installation (if any)..." 190 | remove_plugin 191 | echo 192 | 193 | # Configuration 194 | ############### 195 | 196 | echo "Proceeding with installation..." 197 | mkdir -pv "$PATH_CONFIG" 198 | cp -rv --update=none config/* "$PATH_CONFIG" 199 | 200 | # Code snippets 201 | ############### 202 | 203 | mkdir -pv "$PATH_SNIPPETS_GEDIT" 204 | cp -v snippets/markdown.xml "$PATH_SNIPPETS_GEDIT" 205 | 206 | # External tools 207 | ################ 208 | 209 | mkdir -pv "$PATH_TOOLS_GEDIT" 210 | 211 | cp -v tools/export-to-html "$PATH_TOOLS_GEDIT" 212 | chmod +x "$PATH_TOOLS_GEDIT/export-to-html" 213 | 214 | cp -v tools/export-to-pdf "$PATH_TOOLS_GEDIT" 215 | chmod +x "$PATH_TOOLS_GEDIT/export-to-pdf" 216 | 217 | # Markdown Preview plugin 218 | ######################### 219 | 220 | mkdir -pv "$PATH_PLUGINS_GEDIT" 221 | 222 | if [[ ! -L $PATH_PLUGINS_GEDIT/markdown-preview.plugin ]]; then 223 | cp -v plugins/markdown-preview/markdown-preview.plugin "$PATH_PLUGINS_GEDIT" 224 | fi 225 | 226 | mkdir -pv "$PATH_PLUGIN_MARKDOWN_PREVIEW" 227 | 228 | if [[ ! -L $PATH_PLUGIN_MARKDOWN_PREVIEW ]]; then 229 | cp -rv plugins/markdown-preview/markdown-preview/* "$PATH_PLUGIN_MARKDOWN_PREVIEW" 230 | 231 | # locale 232 | ######## 233 | 234 | rm -v "$PATH_PLUGIN_MARKDOWN_PREVIEW/locale/markdown-preview.pot" 235 | 236 | if command -v msgfmt >/dev/null 2>&1; then 237 | echo "Compiling .po files to .mo files..." 238 | 239 | find "$PATH_PLUGIN_MARKDOWN_PREVIEW/locale/" -name "*.po" -print0 | \ 240 | while IFS= read -r -d '' po; do 241 | mo=${po%.*}.mo 242 | 243 | if msgfmt -o "$mo" "$po"; then 244 | echo "Compiled: $mo" 245 | else 246 | echo "Compilation failed: $mo" 247 | fi 248 | done 249 | else 250 | echo "msgfmt not found. Skipping .po compilation." 251 | fi 252 | 253 | find "$PATH_PLUGIN_MARKDOWN_PREVIEW/locale/" -name "*.po" -exec rm -v {} \; 254 | fi 255 | 256 | echo 257 | echo "Installation successful. Please restart gedit (if it's already running)." 258 | echo 259 | 260 | exit 0 261 | elif [[ $action == uninstall ]]; then 262 | echo "# gedit-markdown uninstall" 263 | echo "##########################" 264 | echo 265 | 266 | remove_plugin 267 | 268 | echo 269 | echo "Uninstallation successful. Please restart gedit (if it's already running)." 270 | echo 271 | 272 | exit 0 273 | else 274 | echo 275 | echo "Usage: $0 [install|uninstall]" 276 | echo 277 | 278 | exit 1 279 | fi 280 | -------------------------------------------------------------------------------- /plugins/markdown-preview/markdown-preview.plugin: -------------------------------------------------------------------------------- 1 | [Plugin] 2 | Loader=python3 3 | Module=markdown-preview 4 | IAge=3 5 | Name=Markdown Preview 6 | Name[fr]=Aperçu Markdown 7 | Name[de]=Markdown Vorschau 8 | Description=Displays the HTML version of the current Markdown document 9 | Description[fr]=Affiche la version HTML du document Markdown actuel 10 | Description[de]=Zeigt die HTML Version des Markdown Textes an, der gerade editiert wird 11 | Authors=Jean-Philippe Fleury , darkdragon-001 , Michele Campeotto 12 | Copyright=Copyright © 2009-2014, 2025 Jean-Philippe Fleury\nCopyright © 2018, 2020 darkdragon-001\nCopyright © 2005, 2006 Michele Campeotto 13 | Website=https://github.com/jpfleury/gedit-markdown 14 | -------------------------------------------------------------------------------- /plugins/markdown-preview/markdown-preview/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # -*- coding: utf-8 -*- 3 | 4 | """ 5 | This file is part of gedit-markdown. 6 | Copyright © 2009-2014, 2025 Jean-Philippe Fleury 7 | Copyright © 2018, 2020 darkdragon-001 8 | Copyright © 2005, 2006 Michele Campeotto 9 | 10 | This program is free software: you can redistribute it and/or modify 11 | it under the terms of the GNU General Public License as published by 12 | the Free Software Foundation, either version 3 of the License, or 13 | (at your option) any later version. 14 | 15 | This program is distributed in the hope that it will be useful, 16 | but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | GNU General Public License for more details. 19 | 20 | You should have received a copy of the GNU General Public License 21 | along with this program. If not, see . 22 | """ 23 | 24 | from __future__ import annotations 25 | 26 | import gettext 27 | import os 28 | import timeit 29 | import urllib.parse 30 | import webbrowser 31 | from configparser import ConfigParser 32 | from threading import Timer 33 | 34 | import gi 35 | 36 | for wkVersion in ["4.1", "4.0"]: 37 | try: 38 | gi.require_version("WebKit2", wkVersion) 39 | break 40 | except ValueError: 41 | continue 42 | else: 43 | raise ImportError("No compatible version of WebKit2 found") 44 | 45 | from gi.repository import ( 46 | Gedit, 47 | Gio, 48 | GObject, 49 | Gtk, 50 | GtkSource, 51 | Tepl, 52 | WebKit2, 53 | ) 54 | 55 | try: 56 | import markdown 57 | except ImportError as exc: 58 | raise ImportError( 59 | "The python-markdown package is required for markdown-preview." 60 | ) from exc 61 | 62 | try: 63 | from pymdownx.pathconverter import PathConverterExtension 64 | 65 | _PATHCONVERTER = True 66 | except ImportError: 67 | _PATHCONVERTER = False 68 | 69 | APP_NAME = "markdown-preview" 70 | LOCALE_DIR = os.path.join(os.path.dirname(__file__), "locale") 71 | gettext.bindtextdomain(APP_NAME, LOCALE_DIR) 72 | gettext.textdomain(APP_NAME) 73 | _ = gettext.gettext 74 | 75 | 76 | def _xdg_config_home() -> str: 77 | try: 78 | import xdg.BaseDirectory as _xdg 79 | 80 | return _xdg.xdg_config_home 81 | except Exception: 82 | return os.path.join(os.environ.get("HOME", "~"), ".config") 83 | 84 | 85 | CONF_DIR = os.path.join(_xdg_config_home(), "gedit", APP_NAME) 86 | CONF_FILE = os.path.join(CONF_DIR, "preferences.ini") 87 | TEMPLATE_FILE = os.path.join(CONF_DIR, "template.html") 88 | 89 | _DEFAULTS: dict[str, str] = { 90 | "panel": "bottom", 91 | "shortcut": "m", 92 | "extensions": "extra toc", 93 | "visibility": "0", 94 | "visibilityShortcut": "v", 95 | "autoIdle": "250", 96 | "autoReloadActivate": "1", 97 | "autoReloadOpen": "1", 98 | "autoReloadSave": "1", 99 | "autoReloadTabs": "0", 100 | "autoReloadEdit": "1", 101 | "autoReloadSelection": "0", 102 | } 103 | 104 | cfg = ConfigParser() 105 | cfg.optionxform = str # Keep key case 106 | cfg.add_section(APP_NAME) 107 | for k, v in _DEFAULTS.items(): 108 | cfg.set(APP_NAME, k, v) 109 | if os.path.isfile(CONF_FILE): 110 | cfg.read(CONF_FILE) 111 | os.makedirs(CONF_DIR, exist_ok=True) 112 | with open(CONF_FILE, "w", encoding="utf-8") as _fp: 113 | cfg.write(_fp) 114 | 115 | P = lambda k: cfg.get(APP_NAME, k) 116 | 117 | markdownPanel = P("panel") 118 | markdownShortcut = P("shortcut") 119 | markdownExtensions = P("extensions") 120 | markdownVisibility = P("visibility") 121 | markdownVisibilityShortcut = P("visibilityShortcut") 122 | markdownAutoIdle = P("autoIdle") 123 | markdownAutoReloadActivate = P("autoReloadActivate") 124 | markdownAutoReloadOpen = P("autoReloadOpen") 125 | markdownAutoReloadSave = P("autoReloadSave") 126 | markdownAutoReloadTabs = P("autoReloadTabs") 127 | markdownAutoReloadEdit = P("autoReloadEdit") 128 | markdownAutoReloadSelection = P("autoReloadSelection") 129 | 130 | markdownExtensionsList = markdownExtensions.split() 131 | markdownAutoIdleSeconds = float(markdownAutoIdle) / 1000.0 132 | 133 | try: 134 | with open(TEMPLATE_FILE, "r", encoding="utf-8") as _fp: 135 | htmlTemplate = _fp.read() 136 | except FileNotFoundError: 137 | htmlTemplate = """%s""" 138 | 139 | 140 | class MarkdownPreviewPlugin(GObject.Object, Gedit.WindowActivatable): 141 | __gtype_name__ = "MarkdownPreviewPlugin" 142 | 143 | window: Gedit.Window = GObject.Property(type=Gedit.Window) 144 | 145 | lastUpdate: float = 0.0 146 | scrollRestore: bool = False 147 | scrollPosition: int | None = None 148 | activeSelection: bool = False 149 | 150 | def do_activate(self): 151 | self.panel_item = None 152 | self.scrolledWindow = Gtk.ScrolledWindow() 153 | self.scrolledWindow.set_policy( 154 | Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC 155 | ) 156 | self.scrolledWindow.set_property("shadow-type", Gtk.ShadowType.IN) 157 | 158 | self.htmlView = WebKit2.WebView() 159 | self.htmlView.get_settings().set_property("enable_javascript", True) 160 | self.htmlView.connect("load-changed", self.onLoadChanged) 161 | self.htmlView.connect("mouse-target-changed", self.onMouseTargetChangedCb) 162 | self.htmlView.connect("decide-policy", self.onDecidePolicyCb) 163 | self.htmlView.connect("context-menu", self.onContextMenuCb) 164 | 165 | self.scrolledWindow.add(self.htmlView) 166 | self.scrolledWindow.show_all() 167 | 168 | if markdownVisibility == "1": 169 | self.addMarkdownPreviewTab() 170 | 171 | self.addWindowActions() 172 | self.handleTabChanged = self.window.connect( 173 | "active-tab-changed", self.onTabChangedCb 174 | ) 175 | self.handleTabStateChanged = self.window.connect( 176 | "active-tab-state-changed", self.onTabChangedCb 177 | ) 178 | self.addBufferSignals() 179 | 180 | if markdownAutoReloadActivate == "1": 181 | self.updatePreview(reason="pluginActivated") 182 | 183 | def do_deactivate(self): 184 | self.removeBufferSignals() 185 | self.window.disconnect(self.handleTabChanged) 186 | self.window.disconnect(self.handleTabStateChanged) 187 | self.window.remove_action("MarkdownPreview") 188 | self.window.remove_action("ToggleTab") 189 | self.removeMarkdownPreviewTab() 190 | if self.htmlView is not None: 191 | self.htmlView.destroy() 192 | if self.scrolledWindow is not None: 193 | self.scrolledWindow.destroy() 194 | self.htmlView = None 195 | self.scrolledWindow = None 196 | 197 | def getMarkdownPanel(self): 198 | return ( 199 | self.window.get_side_panel() 200 | if markdownPanel == "side" 201 | else self.window.get_bottom_panel() 202 | ) 203 | 204 | def isMarkdownPreviewTabAdded(self): 205 | return self.scrolledWindow.get_parent() is not None 206 | 207 | def isMarkdownPreviewTabVisible(self): 208 | panel = self.getMarkdownPanel() 209 | if hasattr(panel, "get_visible_child"): 210 | return panel.get_visible_child() == self.scrolledWindow 211 | if hasattr(panel, "get_visible_child_name"): 212 | return panel.get_visible_child_name() == "MarkdownPreview" 213 | return False 214 | 215 | def isMarkdownPreviewVisible(self): 216 | """Return True if the preview widget is currently mapped (visible).""" 217 | return self.scrolledWindow.get_mapped() 218 | 219 | def addMarkdownPreviewTab(self): 220 | panel = self.getMarkdownPanel() 221 | panel.set_visible(True) 222 | if isinstance(panel, Gtk.Stack): 223 | panel.add_titled( 224 | self.scrolledWindow, 225 | "MarkdownPreview", 226 | _("Markdown Preview"), 227 | ) 228 | self.panel_item = None 229 | else: 230 | try: 231 | self.panel_item = Tepl.Panel.add( 232 | panel, 233 | self.scrolledWindow, 234 | "MarkdownPreview", 235 | _("Markdown Preview"), 236 | None, 237 | ) 238 | except Exception as e: 239 | print("Error Tepl.Panel.add:", e) 240 | self.panel_item = None 241 | return 242 | self.updatePreview(reason="previewVisible") 243 | 244 | def removeMarkdownPreviewTab(self): 245 | panel = self.getMarkdownPanel() 246 | if isinstance(panel, Gtk.Stack): 247 | panel.remove(self.scrolledWindow) 248 | panel.set_visible(False) 249 | elif self.panel_item: 250 | try: 251 | Tepl.Panel.remove(panel, self.panel_item) 252 | panel.set_visible(False) 253 | except Exception as e: 254 | print("Error Tepl.Panel.remove:", e) 255 | 256 | def toggleTab(self): 257 | """Toggle visibility of the preview tab.""" 258 | if not self.isMarkdownPreviewVisible(): 259 | self.addMarkdownPreviewTab() 260 | else: 261 | self.removeMarkdownPreviewTab() 262 | 263 | def addWindowActions(self): 264 | self.action_update = Gio.SimpleAction(name="MarkdownPreview") 265 | self.action_update.connect( 266 | "activate", lambda *_: self.updatePreview(reason="userAction") 267 | ) 268 | self.window.add_action(self.action_update) 269 | self.action_toggle = Gio.SimpleAction(name="ToggleTab") 270 | self.action_toggle.connect("activate", lambda *_: self.toggleTab()) 271 | self.window.add_action(self.action_toggle) 272 | 273 | def addBufferSignals(self): 274 | self.removeBufferSignals() 275 | view = self.window.get_active_view() 276 | if view: 277 | self.handleBuffer = view.get_buffer() 278 | self.handleMarkSet = self.handleBuffer.connect("mark-set", self.onMarkSetCb) 279 | self.handleDocumentLoaded = self.handleBuffer.connect( 280 | "loaded", self.onDocumentLoadedCb 281 | ) 282 | self.handleDocumentSaved = self.handleBuffer.connect( 283 | "saved", self.onDocumentSavedCb 284 | ) 285 | 286 | def removeBufferSignals(self): 287 | if hasattr(self, "handleBuffer") and self.handleBuffer is not None: 288 | self.handleBuffer.disconnect(self.handleMarkSet) 289 | self.handleBuffer.disconnect(self.handleDocumentLoaded) 290 | self.handleBuffer.disconnect(self.handleDocumentSaved) 291 | del ( 292 | self.handleBuffer, 293 | self.handleMarkSet, 294 | self.handleDocumentLoaded, 295 | self.handleDocumentSaved, 296 | ) 297 | 298 | def rememberScroll(self, *_): 299 | js = "window.document.body.scrollTop" 300 | self.htmlView.run_javascript(js, None, self.onRememberScrollFinished, None) 301 | 302 | def restoreScroll(self, *_): 303 | if self.scrollRestore and self.scrollPosition is not None: 304 | js = f"window.document.body.scrollTop = {self.scrollPosition}" 305 | self.htmlView.run_javascript(js, None, None, None) 306 | self.scrollRestore = False 307 | 308 | def onRememberScrollFinished(self, webview, result, _): 309 | res = webview.run_javascript_finish(result) 310 | if res is not None: 311 | value = res.get_js_value() 312 | if not value.is_undefined(): 313 | self.scrollPosition = value.to_int32() 314 | 315 | def onTabChangedCb(self, *_): 316 | self.addBufferSignals() 317 | if markdownAutoReloadTabs == "1": 318 | self.updatePreview(reason="tabChanged") 319 | 320 | def onMarkSetCb(self, _buf, _loc, mark): 321 | if markdownAutoReloadSelection == "1" and mark.get_name() == "insert": 322 | doc = self.handleBuffer 323 | start = doc.get_iter_at_mark(doc.get_selection_bound()) 324 | end = doc.get_iter_at_mark(mark) 325 | if not start.equal(end): 326 | self.autoUpdate() 327 | self.activeSelection = True 328 | elif self.activeSelection: 329 | self.autoUpdate() 330 | self.activeSelection = False 331 | 332 | def onDocumentLoadedCb(self, *_): 333 | if markdownAutoReloadOpen == "1": 334 | self.updatePreview(reason="documentLoaded") 335 | 336 | def onDocumentSavedCb(self, *_): 337 | if markdownAutoReloadSave == "1": 338 | self.updatePreview(reason="documentSaved") 339 | 340 | def onLoadChanged(self, *_): 341 | self.restoreScroll() 342 | 343 | def onMouseTargetChangedCb(self, _view, hitTestResult, _): 344 | self.rememberScroll() 345 | if hitTestResult.context_is_link(): 346 | url = hitTestResult.get_link_uri() 347 | text = (url[:75] + "…") if len(url) > 75 else url 348 | self.window.set_tooltip_text(text) 349 | else: 350 | self.window.set_has_tooltip(False) 351 | 352 | def onDecidePolicyCb(self, _view, decision, decisionType): 353 | if decisionType == WebKit2.PolicyDecisionType.NAVIGATION_ACTION: 354 | currentUri = decision.get_request().get_uri() 355 | if currentUri.startswith("file:///"): 356 | if currentUri.startswith(self.getActiveUri()): 357 | self.updatePreview(reason="navigation") 358 | decision.ignore() 359 | else: 360 | lang = GtkSource.LanguageManager.get_default().guess_language( 361 | currentUri, None 362 | ) 363 | if lang and lang.get_id() == "html": 364 | decision.use() 365 | elif lang and lang.get_id() == "markdown": 366 | with open(currentUri[7:], "r", encoding="utf-8") as _fp: 367 | text = _fp.read() 368 | self.render(text, currentUri, True) 369 | decision.ignore() 370 | else: 371 | self.render() 372 | decision.ignore() 373 | else: 374 | webbrowser.open_new_tab(currentUri) 375 | decision.ignore() 376 | elif decisionType == WebKit2.PolicyDecisionType.NEW_WINDOW_ACTION: 377 | decision.ignore() 378 | elif decisionType == WebKit2.PolicyDecisionType.RESPONSE: 379 | decision.use() 380 | else: 381 | decision.ignore() 382 | return True 383 | 384 | def onContextMenuCb(self, _view, menu, _event, hitTestResult): 385 | for item in menu.get_items(): 386 | try: 387 | act = item.get_stock_action() 388 | if act in ( 389 | WebKit2.ContextMenuAction.OPEN_LINK, 390 | WebKit2.ContextMenuAction.COPY_LINK_TO_CLIPBOARD, 391 | WebKit2.ContextMenuAction.GO_BACK, 392 | WebKit2.ContextMenuAction.GO_FORWARD, 393 | ): 394 | continue 395 | menu.remove(item) 396 | except Exception: 397 | menu.remove(item) 398 | if not hitTestResult.context_is_link(): 399 | menu.append( 400 | WebKit2.ContextMenuItem.new_from_gaction( 401 | self.action_update, _("Update Preview") 402 | ) 403 | ) 404 | 405 | def autoUpdate(self, *_): 406 | if markdownAutoIdleSeconds > 0: 407 | self.lastUpdate = timeit.default_timer() 408 | Timer(markdownAutoIdleSeconds, self.autoUpdateTimerCb).start() 409 | else: 410 | self.updatePreview(reason="editor") 411 | 412 | def autoUpdateTimerCb(self): 413 | if (timeit.default_timer() - self.lastUpdate) >= markdownAutoIdleSeconds: 414 | self.updatePreview(reason="editor") 415 | 416 | def updatePreview(self, *_, **kwargs): 417 | view = self.window.get_active_view() 418 | if not view: 419 | return 420 | doc = view.get_buffer() 421 | lang = doc.get_language() 422 | if lang and lang.get_id() in ("markdown", "html"): 423 | start = doc.get_start_iter() 424 | end = doc.get_end_iter() 425 | if markdownAutoReloadSelection == "1" and doc.get_selection_bounds(): 426 | start = doc.get_iter_at_mark(doc.get_selection_bound()) 427 | end = doc.get_iter_at_mark(doc.get_insert()) 428 | text = doc.get_text(start, end, True) 429 | isMarkdown = lang.get_id() == "markdown" 430 | self.render(text, self.getActiveUri(), isMarkdown) 431 | if kwargs.get("reason") != "navigation": 432 | self.scrollRestore = True 433 | else: 434 | self.render() 435 | 436 | def render( 437 | self, html: str = "", activeUri: str | None = None, isMarkdown: bool = False 438 | ): 439 | if not self.isMarkdownPreviewVisible(): 440 | return 441 | activeUri = activeUri or "file:///" 442 | basePathWebView = self.uriToBase(activeUri) 443 | if isMarkdown: 444 | ext = list(markdownExtensionsList) 445 | if _PATHCONVERTER: 446 | basePathWebView = "file:///" 447 | baseConv = self.uriToBase(activeUri)[7:] 448 | ext.append(PathConverterExtension(base_path=baseConv, absolute=True)) 449 | html = htmlTemplate % markdown.markdown(html, extensions=ext) 450 | self.htmlView.load_alternate_html(html, activeUri, basePathWebView) 451 | 452 | def getActiveUri(self) -> str: 453 | doc = self.window.get_active_document() 454 | if doc is None: 455 | return "file:///" 456 | if hasattr(doc, "get_file"): 457 | tfile = doc.get_file() 458 | if tfile is not None: 459 | loc = tfile.get_location() 460 | if loc is not None: 461 | return loc.get_uri() 462 | if hasattr(doc, "get_location"): 463 | loc = doc.get_location() 464 | if loc is not None: 465 | return loc.get_uri() 466 | if hasattr(doc, "get_uri_for_display"): 467 | uri = doc.get_uri_for_display() 468 | if uri: 469 | return uri if uri.startswith("file://") else "file://" + uri 470 | title = doc.get_short_title() if hasattr(doc, "get_short_title") else "untitled" 471 | return f"file:///{urllib.parse.quote(title)}" 472 | 473 | @staticmethod 474 | def uriToBase(uri: str) -> str: 475 | return uri.rpartition("/")[0] + "/" 476 | 477 | 478 | class MarkdownPreviewMenu(GObject.Object, Gedit.AppActivatable): 479 | """Adds 'Update Markdown Preview' and 'Toggle Markdown Preview Visibility' to the Tools menu.""" 480 | 481 | app: Gedit.App = GObject.Property(type=Gedit.App) 482 | 483 | def do_activate(self): 484 | # Shortcuts 485 | self.app.set_accels_for_action("win.MarkdownPreview", [markdownShortcut]) 486 | self.app.set_accels_for_action("win.ToggleTab", [markdownVisibilityShortcut]) 487 | 488 | # Menu items 489 | self.tools_menu_ext = self.extend_menu("tools-section") 490 | self.tools_menu_ext.append_menu_item( 491 | Gio.MenuItem.new(_("Update Markdown Preview"), "win.MarkdownPreview") 492 | ) 493 | self.tools_menu_ext.append_menu_item( 494 | Gio.MenuItem.new(_("Toggle Markdown Preview Visibility"), "win.ToggleTab") 495 | ) 496 | 497 | def do_deactivate(self): 498 | # Remove shortcuts 499 | self.app.set_accels_for_action("win.MarkdownPreview", []) 500 | self.app.set_accels_for_action("win.ToggleTab", []) 501 | self.tools_menu_ext = None 502 | -------------------------------------------------------------------------------- /plugins/markdown-preview/markdown-preview/locale/de/LC_MESSAGES/markdown-preview.po: -------------------------------------------------------------------------------- 1 | # Deutsche Übersetzung des Markdown Preview Plugins. 2 | # Copyright (C) 2011 Jean-Philippe Fleury 3 | # This file is distributed under the same license as the PACKAGE package. 4 | # FIRST AUTHOR , 2019. 5 | # 6 | #, fuzzy 7 | msgid "" 8 | msgstr "" 9 | "Project-Id-Version: Markdown Preview\n" 10 | "Report-Msgid-Bugs-To: \n" 11 | "POT-Creation-Date: 2025-05-18 23:39-0400\n" 12 | "PO-Revision-Date: 2018-12-13 15:21+0100\n" 13 | "Last-Translator: Erich Küster \n" 14 | "Language-Team: LANGUAGE \n" 15 | "Language: de\n" 16 | "MIME-Version: 1.0\n" 17 | "Content-Type: text/plain; charset=UTF-8\n" 18 | "Content-Transfer-Encoding: 8bit\n" 19 | 20 | #: plugins/markdown-preview/markdown-preview/__init__.py:227 21 | msgid "Markdown Preview" 22 | msgstr "Markdown Vorschau" 23 | 24 | #: plugins/markdown-preview/markdown-preview/__init__.py:390 25 | msgid "Update Preview" 26 | msgstr "Vorschau aktualisieren" 27 | 28 | #: plugins/markdown-preview/markdown-preview/__init__.py:480 29 | msgid "Update Markdown Preview" 30 | msgstr "Markdown Vorschau aktualisieren" 31 | 32 | #: plugins/markdown-preview/markdown-preview/__init__.py:483 33 | msgid "Toggle Markdown Preview Visibility" 34 | msgstr "Sichtbarkeit der Vorschau umschalten" 35 | 36 | #~ msgid "Preview in HTML of the current document or the selection" 37 | #~ msgstr "Vorschau des aktuellen Dokuments oder der Auswahl in HTML anzeigen" 38 | 39 | #~ msgid "Display or hide the Markdown Preview panel tab" 40 | #~ msgstr "Reiter der Markdown Vorschau anzeigen oder verbergen" 41 | 42 | #~ msgid "Enter URL" 43 | #~ msgstr "URL eingeben" 44 | 45 | #~ msgid "Enter the URL (local or distant) of the document or page to display." 46 | #~ msgstr "URL des Dokumentes oder der Seite (lokal oder entfernt) eingeben" 47 | 48 | #~ msgid "Open in the embedded browser" 49 | #~ msgstr "In eingebettetem Browser öffnen" 50 | 51 | #~ msgid "Open in an external browser" 52 | #~ msgstr "In externem Browser öffnen" 53 | 54 | #~ msgid "Copy the current URL" 55 | #~ msgstr "Momentane URL kopieren" 56 | 57 | #~ msgid "Go to another URL" 58 | #~ msgstr "Zu anderer URL gehen" 59 | 60 | #~ msgid "Clear Preview" 61 | #~ msgstr "Vorschau löschen" 62 | 63 | #~ msgid "Toggle Markdown Preview" 64 | #~ msgstr "Markdown Vorschau ein-/ausblenden" 65 | -------------------------------------------------------------------------------- /plugins/markdown-preview/markdown-preview/locale/fr/LC_MESSAGES/markdown-preview.po: -------------------------------------------------------------------------------- 1 | # Traduction en français de Markdown Preview. 2 | # Copyright (C) 2011 Jean-Philippe Fleury 3 | # This file is distributed under the same license as the PACKAGE package. 4 | # 5 | msgid "" 6 | msgstr "" 7 | "Project-Id-Version: Markdown Preview\n" 8 | "Report-Msgid-Bugs-To: \n" 9 | "POT-Creation-Date: 2025-05-18 23:39-0400\n" 10 | "PO-Revision-Date: 2012-06-08 15:50-0400\n" 11 | "Last-Translator: Jean-Philippe Fleury \n" 12 | "Language-Team: \n" 13 | "Language: \n" 14 | "MIME-Version: 1.0\n" 15 | "Content-Type: text/plain; charset=UTF-8\n" 16 | "Content-Transfer-Encoding: 8bit\n" 17 | "Plural-Forms: nplurals=2; plural=(n > 1);\n" 18 | 19 | #: plugins/markdown-preview/markdown-preview/__init__.py:227 20 | msgid "Markdown Preview" 21 | msgstr "Aperçu Markdown" 22 | 23 | #: plugins/markdown-preview/markdown-preview/__init__.py:390 24 | msgid "Update Preview" 25 | msgstr "Actualiser l'aperçu" 26 | 27 | #: plugins/markdown-preview/markdown-preview/__init__.py:480 28 | msgid "Update Markdown Preview" 29 | msgstr "Actualiser l'aperçu Markdown" 30 | 31 | #: plugins/markdown-preview/markdown-preview/__init__.py:483 32 | msgid "Toggle Markdown Preview Visibility" 33 | msgstr "Afficher ou cacher l'aperçu Markdown" 34 | 35 | #~ msgid "Preview in HTML of the current document or the selection" 36 | #~ msgstr "Aperçu en HTML du document courant ou de la sélection" 37 | 38 | #~ msgid "Display or hide the Markdown Preview panel tab" 39 | #~ msgstr "Affiche ou cache l'onglet d'aperçu Markdown" 40 | 41 | #~ msgid "Enter URL" 42 | #~ msgstr "Entrer l'URL" 43 | 44 | #~ msgid "Enter the URL (local or distant) of the document or page to display." 45 | #~ msgstr "" 46 | #~ "Entrer l'URL (locale ou distante) du document ou de la page à afficher." 47 | 48 | #~ msgid "Open in the embedded browser" 49 | #~ msgstr "Ouvrir dans le navigateur intégré" 50 | 51 | #~ msgid "Open in an external browser" 52 | #~ msgstr "Ouvrir dans un navigateur externe" 53 | 54 | #~ msgid "Copy the current URL" 55 | #~ msgstr "Copier l'URL courante" 56 | 57 | #~ msgid "Go to another URL" 58 | #~ msgstr "Aller à une autre URL" 59 | 60 | #~ msgid "Clear Preview" 61 | #~ msgstr "Effacer l'aperçu" 62 | -------------------------------------------------------------------------------- /plugins/markdown-preview/markdown-preview/locale/markdown-preview.pot: -------------------------------------------------------------------------------- 1 | # SOME DESCRIPTIVE TITLE. 2 | # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER 3 | # This file is distributed under the same license as the PACKAGE package. 4 | # FIRST AUTHOR , YEAR. 5 | # 6 | #, fuzzy 7 | msgid "" 8 | msgstr "" 9 | "Project-Id-Version: PACKAGE VERSION\n" 10 | "Report-Msgid-Bugs-To: \n" 11 | "POT-Creation-Date: 2025-05-18 23:39-0400\n" 12 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" 13 | "Last-Translator: FULL NAME \n" 14 | "Language-Team: LANGUAGE \n" 15 | "Language: \n" 16 | "MIME-Version: 1.0\n" 17 | "Content-Type: text/plain; charset=CHARSET\n" 18 | "Content-Transfer-Encoding: 8bit\n" 19 | 20 | #: plugins/markdown-preview/markdown-preview/__init__.py:227 21 | msgid "Markdown Preview" 22 | msgstr "" 23 | 24 | #: plugins/markdown-preview/markdown-preview/__init__.py:390 25 | msgid "Update Preview" 26 | msgstr "" 27 | 28 | #: plugins/markdown-preview/markdown-preview/__init__.py:480 29 | msgid "Update Markdown Preview" 30 | msgstr "" 31 | 32 | #: plugins/markdown-preview/markdown-preview/__init__.py:483 33 | msgid "Toggle Markdown Preview Visibility" 34 | msgstr "" 35 | -------------------------------------------------------------------------------- /snippets/markdown.xml: -------------------------------------------------------------------------------- 1 | 2 | 23 | 24 | 25 | 26 | 27 | 30 | h 31 | Header (atx-style) 32 | 33 | 34 | 35 | 39 | Hs 40 | Header 1 (setext-style) 41 | 42 | 43 | 44 | 48 | hs 49 | Header 2 (setext-style) 50 | 51 | 52 | 53 | 56 | hr 57 | Horizontal Rule 58 | 59 | 60 | 61 | 67 | ul 68 | Unordered List 69 | 70 | 71 | 72 | 78 | ol 79 | Ordered List 80 | 81 | 82 | 83 | 84 | code 85 | Wrap Selection as Code Span 86 | c]]> 87 | 88 | 89 | 90 | 91 | a 92 | Wrap Selection as Inline Link 93 | a]]> 94 | 95 | 96 | 97 | 98 | aref 99 | Wrap Selection as Reference Link 100 | r]]> 101 | 102 | 103 | 104 | 106 | adef 107 | Link Definition 108 | 109 | 110 | 111 | 112 | img 113 | Inline Image 114 | 115 | 116 | 117 | 118 | iref 119 | Reference Image 120 | 121 | 122 | 123 | 124 | 125 | 135 | dl 136 | Definition List 137 | 138 | 139 | 140 | 143 | Code 144 | Wrap Selection as Fenced Code Block 145 | b]]> 146 | 147 | 148 | 149 | 151 | abbr 152 | Abbreviation Definition 153 | 154 | 155 | 156 | 157 | fnref 158 | Footnote Reference 159 | 160 | 161 | 162 | 164 | fndef 165 | Footnote Definition 166 | 167 | 168 | 169 | 176 | table 177 | Table 178 | 179 | 180 | -------------------------------------------------------------------------------- /tools/export-to-html: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # -*- coding: utf-8 -*- 3 | 4 | # [Gedit Tool] 5 | # Name=Export to HTML 6 | # Name[fr]=Exporter en HTML 7 | # Shortcut=h 8 | # Languages=markdown 9 | # Applicability=all 10 | # Input=selection-document 11 | # Output=new-document 12 | # Save-files=nothing 13 | 14 | import os 15 | import sys 16 | from configparser import ConfigParser 17 | 18 | import markdown 19 | 20 | try: 21 | import xdg.BaseDirectory 22 | except ImportError: 23 | homeDir = os.environ.get("HOME") 24 | xdgConfigHome = os.path.join(homeDir, ".config") 25 | else: 26 | xdgConfigHome = xdg.BaseDirectory.xdg_config_home 27 | 28 | confDir = os.path.join(xdgConfigHome, "gedit/markdown-preview") 29 | confFile = os.path.join(confDir, "preferences.ini") 30 | parser = ConfigParser() 31 | 32 | if os.path.isfile(confFile): 33 | parser.read(confFile) 34 | markdownExtensions = parser.get("markdown-preview", "extensions") 35 | else: 36 | markdownExtensions = "extra toc" 37 | markdownExtensionsList = markdownExtensions.split() 38 | 39 | htmlTemplate = "" 40 | templateFile = os.path.join(confDir, "template.html") 41 | with open(templateFile, "r") as f: 42 | htmlTemplate = f.read() 43 | 44 | text = sys.stdin.read() 45 | print("") 46 | 47 | print(htmlTemplate % markdown.markdown(text, extensions=markdownExtensionsList)) 48 | -------------------------------------------------------------------------------- /tools/export-to-pdf: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # [Gedit Tool] 4 | # Name=Export to PDF 5 | # Name[fr]=Exporter en PDF 6 | # Shortcut=p 7 | # Languages=markdown 8 | # Applicability=all 9 | # Input=selection-document 10 | # Output=output-panel 11 | # Save-files=nothing 12 | 13 | if ! command -v pandoc >/dev/null 2>&1; then 14 | echo >&2 'pandoc is not installed.' 15 | echo >&2 '"sudo apt-get install pandoc texlive" should fix this on Ubuntu / Debian systems.' 16 | exit 1 17 | fi 18 | 19 | if [[ -z $GEDIT_CURRENT_DOCUMENT_NAME || -z $GEDIT_CURRENT_DOCUMENT_PATH ]]; then 20 | echo >&2 'gedit environment variables are missing.' 21 | exit 1 22 | fi 23 | 24 | FILENAME=$GEDIT_CURRENT_DOCUMENT_NAME 25 | FILEPATH=$GEDIT_CURRENT_DOCUMENT_PATH 26 | NEW_FILENAME=${FILENAME%%.*}.pdf 27 | 28 | echo "Exporting to $FILEPATH/$NEW_FILENAME..." 29 | 30 | pandoc "$FILEPATH/$FILENAME" -o "$FILEPATH/$NEW_FILENAME" 31 | exit_code=$? 32 | 33 | if [[ $exit_code == 0 ]]; then 34 | echo 'Export successful.' 35 | else 36 | echo >&2 "pandoc didn't complete successfully (exit code $exit_code)." 37 | exit 1 38 | fi 39 | --------------------------------------------------------------------------------