├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── .gitignore ├── LICENSE ├── README.md ├── buffer.py ├── demo.md ├── dependencies.json ├── eaf-markdown-previewer.el ├── package-lock.json ├── package.json ├── render.js └── screenshot.png /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: EAF Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | - If EAF was working correctly until a recent `git pull`, please refer to [Mandatory Procedures to Keep Your EAF Up-to-Date](https://github.com/manateelazycat/emacs-application-framework/discussions/527?sort=new) first. 11 | - Please check the `*eaf*` buffer, if there is any error shown in the `*eaf*` buffer, paste it here. 12 | 13 | **Describe the bug** 14 | A clear and concise description of what the bug is. 15 | 16 | **To Reproduce** 17 | Ensure you're on the latest master branch, then note the steps to reproduce the behavior. 18 | 19 | **Expected behavior** 20 | A clear and concise description of what you expected to happen. 21 | 22 | **Versions (please complete the following info):** 23 | - Distro and DE/WM: 24 | - Versions of Dependencies: 25 | - M-x emacs-version: 26 | 27 | **Screenshots** 28 | If applicable, add screenshots to help explain your problem. 29 | 30 | **Additional context** 31 | Add any other context about the problem here. 32 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: EAF Feature request 3 | about: Suggest an idea for the Emacs Application Framework 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of an alternative solutions or features you've considered, if any. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | *.pyc 3 | /.log/ 4 | __pycache__ 5 | node_modules/ 6 | dist/ 7 | tags -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ### EAF Markdown Previewer 2 |

3 | 4 |

5 | 6 | Markdown Previewer application for the [Emacs Application Framework](https://github.com/emacs-eaf/emacs-application-framework), it's compatible with Github style, supports the rendering of Mermaid, Plantuml, Katex, Mathjax, etc. 7 | 8 | ### Load application 9 | 10 | [Install EAF](https://github.com/emacs-eaf/emacs-application-framework#install) first, then add below code in your emacs config: 11 | 12 | ```Elisp 13 | (add-to-list 'load-path "~/.emacs.d/site-lisp/emacs-application-framework/") 14 | (require 'eaf) 15 | (require 'eaf-markdown-previewer) 16 | ``` 17 | 18 | ### Using 19 | 20 | `M-x eaf-open` , select the markdown file you want to preview, preview will update when markdown file save. 21 | 22 | If you want preview update in real-time when you changed markdown buffer, you need install my another plugin [auto-save](https://github.com/manateelazycat/auto-save) 23 | 24 | ### Dependency List 25 | 26 | | Package | Description | 27 | | :-------- | :------ | 28 | | python-markdown | Markdown preview | 29 | 30 | ### The keybinding of EAF Markdown Previewer. 31 | 32 | | Key | Event | 33 | | :---- | :------ | 34 | | `C--` | zoom_out | 35 | | `C-=` | zoom_in | 36 | | `C-0` | zoom_reset | 37 | | `C-s` | search_text_forward | 38 | | `C-r` | search_text_backward | 39 | | `C-n` | scroll_up | 40 | | `C-p` | scroll_down | 41 | | `C-f` | scroll_right | 42 | | `C-b` | scroll_left | 43 | | `C-v` | scroll_up_page | 44 | | `C-y` | yank_text | 45 | | `C-w` | kill_text | 46 | | `M-e` | atomic_edit | 47 | | `M-c` | caret_toggle_browsing | 48 | | `M-D` | select_text | 49 | | `M-s` | open_link | 50 | | `M-S` | open_link_new_buffer | 51 | | `M-B` | open_link_background_buffer | 52 | | `C-/` | undo_action | 53 | | `M-_` | redo_action | 54 | | `M-w` | copy_text | 55 | | `M-f` | history_forward | 56 | | `M-b` | history_backward | 57 | | `M-q` | clear_cookies | 58 | | `C-t` | toggle_password_autofill | 59 | | `C-d` | save_page_password | 60 | | `C-M-q` | clear_history | 61 | | `C-M-i` | import_chrome_history | 62 | | `M-v` | scroll_down_page | 63 | | `M-<` | scroll_to_begin | 64 | | `M->` | scroll_to_bottom | 65 | | `M-p` | duplicate_page | 66 | | `M-t` | new_blank_page | 67 | | `M-d` | toggle_dark_mode | 68 | | `SPC` | insert_or_scroll_up_page | 69 | | `J` | insert_or_select_left_tab | 70 | | `K` | insert_or_select_right_tab | 71 | | `j` | insert_or_scroll_up | 72 | | `k` | insert_or_scroll_down | 73 | | `h` | insert_or_scroll_left | 74 | | `l` | insert_or_scroll_right | 75 | | `f` | insert_or_open_link | 76 | | `F` | insert_or_open_link_new_buffer | 77 | | `B` | insert_or_open_link_background_buffer | 78 | | `c` | insert_or_caret_at_line | 79 | | `u` | insert_or_scroll_down_page | 80 | | `d` | insert_or_scroll_up_page | 81 | | `H` | insert_or_history_backward | 82 | | `L` | insert_or_history_forward | 83 | | `t` | insert_or_new_blank_page | 84 | | `T` | insert_or_recover_prev_close_page | 85 | | `i` | insert_or_focus_input | 86 | | `I` | insert_or_open_downloads_setting | 87 | | `r` | insert_or_refresh_page | 88 | | `g` | insert_or_scroll_to_begin | 89 | | `x` | insert_or_close_buffer | 90 | | `G` | insert_or_scroll_to_bottom | 91 | | `-` | insert_or_zoom_out | 92 | | `=` | insert_or_zoom_in | 93 | | `0` | insert_or_zoom_reset | 94 | | `m` | insert_or_save_as_bookmark | 95 | | `o` | insert_or_open_browser | 96 | | `y` | insert_or_download_youtube_video | 97 | | `Y` | insert_or_download_youtube_audio | 98 | | `p` | insert_or_toggle_device | 99 | | `P` | insert_or_duplicate_page | 100 | | `1` | insert_or_save_as_pdf | 101 | | `2` | insert_or_save_as_single_file | 102 | | `3` | insert_or_save_as_screenshot | 103 | | `v` | insert_or_view_source | 104 | | `e` | insert_or_edit_url | 105 | | `n` | insert_or_export_text | 106 | | `,` | insert_or_switch_to_reader_mode | 107 | | `.` | insert_or_translate_text | 108 | | `;` | insert_or_translate_page | 109 | | `C-M-c` | copy_code | 110 | | `C-M-l` | copy_link | 111 | | `C-a` | select_all_or_input_text | 112 | | `M-u` | clear_focus | 113 | | `C-j` | open_downloads_setting | 114 | | `M-o` | eval_js | 115 | | `M-O` | eval_js_file | 116 | | `` | eaf-browser-send-esc-or-exit-fullscreen | 117 | | `M-,` | eaf-send-down-key | 118 | | `M-.` | eaf-send-up-key | 119 | | `M-m` | eaf-send-return-key | 120 | | `` | refresh_page | 121 | | `` | open_devtools | 122 | | `` | eaf-send-ctrl-return-sequence | 123 | -------------------------------------------------------------------------------- /buffer.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright (C) 2018 Andy Stewart 5 | # 6 | # Author: Andy Stewart 7 | # Maintainer: Andy Stewart 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | 23 | import os 24 | import platform 25 | import subprocess 26 | import tempfile 27 | from urllib.error import URLError 28 | from urllib.parse import urlencode 29 | from urllib.request import urlopen 30 | 31 | from core.utils import PostGui, eval_in_emacs, get_app_dark_mode, get_free_port, interactive, message_to_emacs 32 | from core.webengine import BrowserBuffer 33 | from PyQt6.QtCore import QFileSystemWatcher, QUrl 34 | from retrying import retry 35 | 36 | 37 | class AppBuffer(BrowserBuffer): 38 | 39 | def __init__(self, buffer_id, url, arguments): 40 | BrowserBuffer.__init__(self, buffer_id, url, arguments, False) 41 | 42 | self.url = url 43 | self.preview_file = tempfile.mkstemp(prefix='eaf-', suffix='.html', text=True)[1] 44 | self.render_js = os.path.join(os.path.dirname(__file__), "render.js") 45 | self.server_port = get_free_port() 46 | self.dark_mode = get_app_dark_mode("eaf-markdown-dark-mode") 47 | 48 | self.buffer_widget.init_dark_mode_js(__file__) 49 | 50 | self.draw_progressbar = True 51 | 52 | # Check puml code and Java is installed. 53 | with open(url, "r", encoding="utf-8", errors="ignore") as f: 54 | import shutil 55 | if "```puml" in f.read() and shutil.which("java") is None: 56 | message_to_emacs("Have PlantUML code in file '{}', you need to install Java to preview normally.".format(os.path.basename(url))) 57 | 58 | self.run_render_server() 59 | self.render() 60 | 61 | self.file_watcher = QFileSystemWatcher() 62 | self.file_watcher.fileChanged.connect(self.on_file_changed) 63 | self.file_watcher.addPath(url) 64 | 65 | def run_render_server(self): 66 | args = ["node", self.render_js, str(self.server_port)] 67 | subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, shell=False) 68 | 69 | @PostGui() 70 | def on_file_changed(self, *args): 71 | self.render() 72 | 73 | def retry_if_connection_refused(ex): 74 | return isinstance(ex, URLError) and isinstance(ex.reason, ConnectionRefusedError) 75 | 76 | @retry(wait_fixed=500, stop_max_attempt_number=10, retry_on_exception=retry_if_connection_refused) 77 | def render(self): 78 | params = { 79 | "input_file": self.url, 80 | "output_file": self.preview_file, 81 | "dark_mode": str(self.dark_mode).lower() 82 | } 83 | url = 'http://127.0.0.1:{}?{}'.format(self.server_port, urlencode(params)) 84 | with urlopen(url) as f: 85 | resp = f.read().decode("utf-8") 86 | if resp == "ok": 87 | self.buffer_widget.load(QUrl.fromLocalFile(self.preview_file)) 88 | if platform.system() == "Windows": 89 | eval_in_emacs('eaf-activate-emacs-window', []) 90 | else: 91 | message_to_emacs("preview failed: {}".format(resp)) 92 | 93 | @interactive 94 | def update_theme(self): 95 | self.dark_mode = get_app_dark_mode("eaf-markdown-dark-mode") 96 | self.render() 97 | -------------------------------------------------------------------------------- /demo.md: -------------------------------------------------------------------------------- 1 | # Markdown Preview 2 | 3 | markdown compilation test, modified from [remarkable demo](https://jonschlinkert.github.io/remarkable/demo/). 4 | 5 | --- 6 | 7 | # h1 Heading 8 | 9 | ## h2 Heading 10 | 11 | ### h3 Heading 12 | 13 | #### h4 Heading 14 | 15 | ##### h5 Heading 16 | 17 | ###### h6 Heading 18 | 19 | ## Horizontal Rules 20 | 21 | --- 22 | 23 | --- 24 | 25 | --- 26 | 27 | ## Math 28 | 29 | $ 30 | \left( \begin{array}{ccc} 31 | a & b & c \\ 32 | d & e & f \\ 33 | g & h & i \end{array} \right)$ 34 | is given by the formula 35 | 36 | $$ 37 | \chi(\lambda) = \left| \begin{array}{ccc} 38 | \lambda - a & -b & -c \\ 39 | -d & \lambda - e & -f \\ 40 | -g & -h & \lambda - i \end{array} \right| 41 | $$ 42 | 43 | ## Diagrams 44 | 45 | ```mermaid 46 | graph TD; 47 | A-->B; 48 | A-->C; 49 | B-->D; 50 | D-->A 51 | ``` 52 | 53 | ```mermaid 54 | sequenceDiagram 55 | participant Alice 56 | participant Bob 57 | Alice->John: Hello John, how are you? 58 | loop Healthcheck 59 | John->John: Fight against hypochondria 60 | end 61 | Note right of John: Rational thoughts
prevail... 62 | John-->Alice: Great! 63 | John->Bob: How about you? 64 | Bob-->John: Jolly good! 65 | ``` 66 | 67 | ```puml 68 | class A { 69 | + init(); 70 | } 71 | ``` 72 | 73 | ## Code Chunk 74 | 75 | ```gnuplot {cmd: "gnuplot", output:"html", hide:true, stdin:true} 76 | set term svg 77 | set title 78 | set key outside 79 | set title "plot with filledcurve [options]" 80 | plot [-10:10] [-5:3] \ 81 | 1.5+sin(x)/x with filledcurve x2, \ 82 | sin(x)/x with filledcurve, \ 83 | 1+sin(x)/x with lines, \ 84 | -1+sin(x)/x with filledcurve y1=-2, \ 85 | -2.5+sin(x)/x with filledcurve xy=-5,-4., \ 86 | -4.3+sin(x)/x with filledcurve x1, \ 87 | (x>3.5 ? x/3-3 : 1/0) with filledcurve y2 88 | ``` 89 | 90 | ```python {cmd, hide:true, output:"html"} 91 | print('hello world') 92 | ``` 93 | 94 | ## Typographic replacements 95 | 96 | Enable typographer option to see result. 97 | 98 | (c) (C) (r) (R) (tm) (TM) (p) (P) +- 99 | 100 | test.. test... test..... test?..... test!.... 101 | 102 | !!!!!! ???? ,, 103 | 104 | Remarkable -- awesome 105 | 106 | "Smartypants, double quotes" 107 | 108 | 'Smartypants, single quotes' 109 | 110 | ## Emphasis 111 | 112 | **This is bold text** 113 | 114 | 115 | __This is bold text__ 116 | 117 | 118 | *This is italic text* 119 | 120 | _This is italic text_ 121 | 122 | ~~Deleted text~~ 123 | 124 | Superscript: 19^th^ 125 | 126 | Subscript: H~2~O 127 | 128 | ++Inserted text++ 129 | 130 | ==Marked text== 131 | 132 | ## Blockquotes 133 | 134 | 135 | > Blockquotes can also be nested... 136 | >> ...by using additional greater-than signs right next to each other... 137 | > > > ...or with spaces between arrows. 138 | 139 | 140 | ## Lists 141 | 142 | Unordered 143 | 144 | 145 | 146 | + Create a list by starting a line with `+`, `-`, or `*` 147 | + Sub-lists are made by indenting 2 spaces: 148 | - Marker character change forces new list start: 149 | * Ac tristique libero volutpat at 150 | + Facilisis in pretium nisl aliquet 151 | - Nulla volutpat aliquam velit 152 | + Very easy! 153 | 154 | 155 | 156 | Ordered 157 | 158 | 1. Lorem ipsum dolor sit amet 159 | 2. Consectetur adipiscing elit 160 | 3. Integer molestie lorem at massa 161 | 162 | 163 | 164 | 1. You can use sequential numbers... 165 | 1. ...or keep all the numbers as `1.` 166 | 167 | Start numbering with offset: 168 | 169 | 57. foo 170 | 1. bar 171 | 172 | ## Code 173 | 174 | Inline `code` 175 | 176 | Indented code 177 | 178 | // Some comments 179 | line 1 of code 180 | line 2 of code 181 | line 3 of code 182 | 183 | Block code "fences" 184 | 185 | ``` 186 | Sample text here... 187 | ``` 188 | 189 | Syntax highlighting 190 | 191 | ```js 192 | var foo = function(bar) { 193 | return bar++; 194 | }; 195 | 196 | console.log(foo(5)); 197 | ``` 198 | 199 | ## Tables 200 | 201 | | Option | Description | 202 | | ------ | ------------------------------------------------------------------------- | 203 | | data | path to data files to supply the data that will be passed into templates. | 204 | | engine | engine to be used for processing templates. Handlebars is the default. | 205 | | ext | extension to be used for dest files. | 206 | 207 | Right aligned columns 208 | 209 | | Option | Description | 210 | | -----: | ------------------------------------------------------------------------: | 211 | | data | path to data files to supply the data that will be passed into templates. | 212 | | engine | engine to be used for processing templates. Handlebars is the default. | 213 | | ext | extension to be used for dest files. | 214 | 215 | ## Links 216 | 217 | [link text](http://dev.nodeca.com) 218 | 219 | [link with title](http://nodeca.github.io/pica/demo/ "title text!") 220 | 221 | Autoconverted link https://github.com/nodeca/pica (enable linkify to see) 222 | 223 | ## Images 224 | 225 | ![Minion](https://octodex.github.com/images/minion.png) 226 | ![Stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") 227 | 228 | Like links, Images also have a footnote style syntax 229 | 230 | ![Alt text][id] 231 | 232 | With a reference later in the document defining the URL location: 233 | 234 | [id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" 235 | 236 | ## Footnotes 237 | 238 | Footnote 1 link[^first]. 239 | 240 | Footnote 2 link[^second]. 241 | 242 | Inline footnote^[Text of inline footnote] definition. 243 | 244 | Duplicated footnote reference[^second]. 245 | 246 | [^first]: Footnote **can have markup** 247 | 248 | and multiple paragraphs. 249 | 250 | [^second]: Footnote text. 251 | 252 | ## Definition lists 253 | 254 | Term 1 255 | 256 | : Definition 1 257 | with lazy continuation. 258 | 259 | Term 2 with _inline markup_ 260 | 261 | : Definition 2 262 | 263 | { some code, part of Definition 2 } 264 | 265 | Third paragraph of definition 2. 266 | 267 | _Compact style:_ 268 | 269 | Term 1 270 | ~ Definition 1 271 | 272 | Term 2 273 | ~ Definition 2a 274 | ~ Definition 2b 275 | 276 | ## Abbreviations 277 | 278 | This is HTML abbreviation example. 279 | 280 | It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on. 281 | 282 | \*[HTML]: Hyper Text Markup Language 283 | 284 | --- 285 | 286 | **Advertisement :)** 287 | 288 | - **[pica](https://nodeca.github.io/pica/demo/)** - high quality and fast image 289 | resize in browser. 290 | - **[babelfish](https://github.com/nodeca/babelfish/)** - developer friendly 291 | i18n with plurals support and easy syntax. 292 | 293 | You'll like those projects! :) 294 | -------------------------------------------------------------------------------- /dependencies.json: -------------------------------------------------------------------------------- 1 | { 2 | "pacman":[ 3 | "python-markdown" 4 | ], 5 | "emerge": [ 6 | "dev-python/markdown" 7 | ], 8 | "apt": [ 9 | "python3-markdown" 10 | ], 11 | "dnf": [ 12 | "python3-markdown" 13 | ], 14 | "pip": { 15 | "linux": [ 16 | "retrying", 17 | "markdown" 18 | ], 19 | "win32": [ 20 | "retrying", 21 | "markdown" 22 | ], 23 | "darwin": [ 24 | "retrying", 25 | "markdown" 26 | ] 27 | }, 28 | "npm_install": true 29 | } 30 | -------------------------------------------------------------------------------- /eaf-markdown-previewer.el: -------------------------------------------------------------------------------- 1 | ;;; eaf-markdown-previewer.el --- Markdown previewer 2 | 3 | ;; Filename: eaf-markdown-previewer.el 4 | ;; Description: Markdown previewer 5 | ;; Author: Andy Stewart 6 | ;; Maintainer: Andy Stewart 7 | ;; Copyright (C) 2021, Andy Stewart, all rights reserved. 8 | ;; Created: 2021-07-31 17:15:43 9 | ;; Version: 0.1 10 | ;; Last-Updated: 2021-07-31 17:15:43 11 | ;; By: Andy Stewart 12 | ;; URL: http://www.emacswiki.org/emacs/download/eaf-markdown-previewer.el 13 | ;; Keywords: 14 | ;; Compatibility: GNU Emacs 28.0.50 15 | ;; 16 | ;; Features that might be required by this library: 17 | ;; 18 | ;; 19 | ;; 20 | 21 | ;;; This file is NOT part of GNU Emacs 22 | 23 | ;;; License 24 | ;; 25 | ;; This program is free software; you can redistribute it and/or modify 26 | ;; it under the terms of the GNU General Public License as published by 27 | ;; the Free Software Foundation; either version 3, or (at your option) 28 | ;; any later version. 29 | 30 | ;; This program is distributed in the hope that it will be useful, 31 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 32 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 33 | ;; GNU General Public License for more details. 34 | 35 | ;; You should have received a copy of the GNU General Public License 36 | ;; along with this program; see the file COPYING. If not, write to 37 | ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth 38 | ;; Floor, Boston, MA 02110-1301, USA. 39 | 40 | ;;; Commentary: 41 | ;; 42 | ;; Markdown previewer 43 | ;; 44 | 45 | ;;; Installation: 46 | ;; 47 | ;; Put eaf-markdown-previewer.el to your load-path. 48 | ;; The load-path is usually ~/elisp/. 49 | ;; It's set in your ~/.emacs like this: 50 | ;; (add-to-list 'load-path (expand-file-name "~/elisp")) 51 | ;; 52 | ;; And the following to your ~/.emacs startup file. 53 | ;; 54 | ;; (require 'eaf-markdown-previewer) 55 | ;; 56 | ;; No need more. 57 | 58 | ;;; Customize: 59 | ;; 60 | ;; 61 | ;; 62 | ;; All of the above can customize by: 63 | ;; M-x customize-group RET eaf-markdown-previewer RET 64 | ;; 65 | 66 | ;;; Change log: 67 | ;; 68 | ;; 2021/07/31 69 | ;; * First released. 70 | ;; 71 | 72 | ;;; Acknowledgements: 73 | ;; 74 | ;; 75 | ;; 76 | 77 | ;;; TODO 78 | ;; 79 | ;; 80 | ;; 81 | 82 | ;;; Require 83 | 84 | 85 | ;;; Code: 86 | 87 | (defcustom eaf-markdown-dark-mode "follow" 88 | "" 89 | :type 'string) 90 | 91 | (defcustom eaf-markdown-previewer-keybinding 92 | '(("C--" . "zoom_out") 93 | ("C-=" . "zoom_in") 94 | ("C-0" . "zoom_reset") 95 | ("C-s" . "search_text_forward") 96 | ("C-r" . "search_text_backward") 97 | ("C-n" . "scroll_up") 98 | ("C-p" . "scroll_down") 99 | ("C-f" . "scroll_right") 100 | ("C-b" . "scroll_left") 101 | ("C-v" . "scroll_up_page") 102 | ("C-y" . "yank_text") 103 | ("C-w" . "kill_text") 104 | ("M-e" . "atomic_edit") 105 | ("M-c" . "caret_toggle_browsing") 106 | ("M-D" . "select_text") 107 | ("M-s" . "open_link") 108 | ("M-S" . "open_link_new_buffer") 109 | ("M-B" . "open_link_background_buffer") 110 | ("C-/" . "undo_action") 111 | ("M-_" . "redo_action") 112 | ("M-w" . "copy_text") 113 | ("M-f" . "history_forward") 114 | ("M-b" . "history_backward") 115 | ("M-q" . "clear_cookies") 116 | ("C-t" . "toggle_password_autofill") 117 | ("C-d" . "save_page_password") 118 | ("C-M-q" . "clear_history") 119 | ("C-M-i" . "import_chrome_history") 120 | ("M-v" . "scroll_down_page") 121 | ("M-<" . "scroll_to_begin") 122 | ("M->" . "scroll_to_bottom") 123 | ("M-p" . "duplicate_page") 124 | ("M-t" . "new_blank_page") 125 | ("M-d" . "toggle_dark_mode") 126 | ("SPC" . "insert_or_scroll_up_page") 127 | ("J" . "insert_or_select_left_tab") 128 | ("K" . "insert_or_select_right_tab") 129 | ("j" . "insert_or_scroll_up") 130 | ("k" . "insert_or_scroll_down") 131 | ("h" . "insert_or_scroll_left") 132 | ("l" . "insert_or_scroll_right") 133 | ("f" . "insert_or_open_link") 134 | ("F" . "insert_or_open_link_new_buffer") 135 | ("B" . "insert_or_open_link_background_buffer") 136 | ("c" . "insert_or_caret_at_line") 137 | ("u" . "insert_or_scroll_down_page") 138 | ("d" . "insert_or_scroll_up_page") 139 | ("H" . "insert_or_history_backward") 140 | ("L" . "insert_or_history_forward") 141 | ("t" . "insert_or_new_blank_page") 142 | ("T" . "insert_or_recover_prev_close_page") 143 | ("i" . "insert_or_focus_input") 144 | ("I" . "insert_or_open_downloads_setting") 145 | ("r" . "insert_or_refresh_page") 146 | ("g" . "insert_or_scroll_to_begin") 147 | ("x" . "insert_or_close_buffer") 148 | ("G" . "insert_or_scroll_to_bottom") 149 | ("-" . "insert_or_zoom_out") 150 | ("=" . "insert_or_zoom_in") 151 | ("0" . "insert_or_zoom_reset") 152 | ("m" . "insert_or_save_as_bookmark") 153 | ("o" . "insert_or_open_browser") 154 | ("y" . "insert_or_download_youtube_video") 155 | ("Y" . "insert_or_download_youtube_audio") 156 | ("p" . "insert_or_toggle_device") 157 | ("P" . "insert_or_duplicate_page") 158 | ("1" . "insert_or_save_as_pdf") 159 | ("2" . "insert_or_save_as_single_file") 160 | ("3" . "insert_or_save_as_screenshot") 161 | ("v" . "insert_or_view_source") 162 | ("e" . "insert_or_edit_url") 163 | ("n" . "insert_or_export_text") 164 | ("," . "insert_or_switch_to_reader_mode") 165 | ("." . "insert_or_translate_text") 166 | (";" . "insert_or_translate_page") 167 | ("C-M-c" . "copy_code") 168 | ("C-M-l" . "copy_link") 169 | ("C-a" . "select_all_or_input_text") 170 | ("M-u" . "clear_focus") 171 | ("C-j" . "open_downloads_setting") 172 | ("M-o" . "eval_js") 173 | ("M-O" . "eval_js_file") 174 | ("" . "eaf-browser-send-esc-or-exit-fullscreen") 175 | ("M-," . "eaf-send-down-key") 176 | ("M-." . "eaf-send-up-key") 177 | ("M-m" . "eaf-send-return-key") 178 | ("" . "refresh_page") 179 | ("" . "open_devtools") 180 | ("" . "eaf-send-ctrl-return-sequence") 181 | ) 182 | "The keybinding of EAF Markdown Previewer." 183 | :type 'cons) 184 | 185 | (defcustom eaf-markdown-extension-list 186 | '("md") 187 | "The extension list of markdown previewer application." 188 | :type 'cons) 189 | 190 | (defun eaf--markdown-preview-display (buf) 191 | "Given BUF, split window to show file and previewer." 192 | (eaf-split-preview-windows 193 | (buffer-local-value 194 | 'eaf--buffer-url buf)) 195 | (switch-to-buffer buf) 196 | (other-window +1)) 197 | 198 | (defun eaf-markdown-previewer-open (&optional file) 199 | (interactive) 200 | (eaf--open-internal (or file (buffer-file-name)) "markdown-previewer" "") 201 | ;; We need call `eaf-monitor-configuration-change' to force EAF render view. 202 | (eaf-monitor-configuration-change)) 203 | 204 | (add-to-list 'eaf-app-binding-alist '("markdown-previewer" . eaf-markdown-previewer-keybinding)) 205 | 206 | (setq eaf-markdown-previewer-path (concat (file-name-directory load-file-name) "buffer.py")) 207 | (add-to-list 'eaf-app-module-path-alist '("markdown-previewer" . eaf-markdown-previewer-path)) 208 | 209 | (add-to-list 'eaf-preview-display-function-alist '("markdown-previewer" . eaf--markdown-preview-display)) 210 | 211 | (add-to-list 'eaf-app-extensions-alist '("markdown-previewer" . eaf-markdown-extension-list)) 212 | 213 | (provide 'eaf-markdown-previewer) 214 | 215 | ;;; eaf-markdown-previewer.el ends here 216 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "eaf-markdown-previewer", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "server.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/emacs-eaf/emacs-application-framework.git" 12 | }, 13 | "author": "", 14 | "license": "GPL-3.0-or-later", 15 | "bugs": { 16 | "url": "https://github.com/emacs-eaf/emacs-application-framework/issues" 17 | }, 18 | "homepage": "https://github.com/emacs-eaf/emacs-application-framework#readme", 19 | "dependencies": { 20 | "@shd101wyy/mume": "^0.6.8", 21 | "darkreader": "^4.9.34" 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /render.js: -------------------------------------------------------------------------------- 1 | const path = require("path"); 2 | const fs = require("fs"); 3 | const os = require("os"); 4 | const http = require("http"); 5 | const url = require("url"); 6 | 7 | const mume = require("@shd101wyy/mume"); 8 | 9 | function readFile(file, options) { 10 | return new Promise((resolve, reject) => { 11 | fs.readFile(file, options, (error, text) => { 12 | if (error) { 13 | return reject(error.toString()); 14 | } 15 | else { 16 | return resolve(text.toString()); 17 | } 18 | }); 19 | }); 20 | } 21 | 22 | function writeFile(file, text, options) { 23 | return new Promise((resolve, reject) => { 24 | fs.writeFile(file, text, options, (error) => { 25 | if (error) { 26 | return reject(error.toString()); 27 | } 28 | else { 29 | return resolve(); 30 | } 31 | }); 32 | }); 33 | } 34 | 35 | async function render(inputFile, outputFile, darkMode) { 36 | const configPath = path.resolve(os.homedir(), ".mume"); 37 | await mume.init(configPath); 38 | 39 | const engine = new mume.MarkdownEngine({ 40 | filePath: inputFile, 41 | config: { 42 | configPath: configPath, 43 | previewTheme: darkMode ? "atom-dark.css" : "atom-light.css", 44 | mermaidTheme: darkMode ? "mermaid.dark.css" : "mermaid.css", 45 | codeBlockTheme: darkMode ? "atom-dark.css" : "atom-light.css", 46 | printBackground: true, 47 | enableScriptExecution: true, 48 | }, 49 | }); 50 | 51 | const inputString = await readFile(inputFile, { 52 | encoding: "utf-8", 53 | }); 54 | let html; 55 | let yamlConfig; 56 | ({ html, yamlConfig } = await engine.parseMD(inputString, { 57 | useRelativeFilePath: false, 58 | hideFrontMatter: true, 59 | isForPreview: false, 60 | runAllCodeChunks: true, 61 | })); 62 | html = await engine.generateHTMLTemplateForExport(html, yamlConfig, { 63 | isForPrint: false, 64 | isForPrince: false, 65 | offline: true, 66 | embedLocalImages: false, 67 | }); 68 | 69 | await writeFile(outputFile, html); 70 | } 71 | 72 | async function server_handler(req, resp) { 73 | const q = url.parse(req.url, true).query; 74 | const inputFile = q.input_file; 75 | const outputFile = q.output_file; 76 | const darkMode = q.dark_mode == "true"; 77 | 78 | resp.writeHead(200, {'Content-Type': 'text/plain'}); 79 | try { 80 | await render(inputFile, outputFile, darkMode); 81 | resp.end('ok'); 82 | } catch (err) { 83 | resp.end(err.message); 84 | } 85 | } 86 | 87 | async function main() { 88 | const argv = process.argv; 89 | const port = Number(argv[2]); 90 | http.createServer(server_handler).listen(port); 91 | } 92 | 93 | main() 94 | 95 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emacs-eaf/eaf-markdown-previewer/426a4d814e9b9ab3db8aabf545b41dbd0c8300d1/screenshot.png --------------------------------------------------------------------------------