├── .editorconfig ├── .eslintrc.json ├── .gitignore ├── LICENSE ├── README.md ├── build.md ├── esbuild.config.mjs ├── example.png ├── manifest.json ├── package.json ├── src ├── common.ts ├── index_widget.ts ├── main.ts ├── preview_processor.ts ├── reader_observer.ts ├── state_parser.ts └── view_observer.ts ├── styles.css ├── tsconfig.json └── versions.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # top-most EditorConfig file 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | insert_final_newline = true 7 | indent_style = tab 8 | indent_size = 4 9 | tab_width = 4 10 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "es2021": true 5 | }, 6 | "extends": [ 7 | "eslint:recommended", 8 | "plugin:@typescript-eslint/recommended" 9 | ], 10 | "overrides": [ 11 | ], 12 | "parser": "@typescript-eslint/parser", 13 | "parserOptions": { 14 | "ecmaVersion": "latest", 15 | "sourceType": "module" 16 | }, 17 | "plugins": [ 18 | "@typescript-eslint" 19 | ], 20 | "rules": { 21 | "quotes": ["error", "single"], 22 | "semi": ["error", "always"], 23 | "indent": ["error", 4], 24 | "no-multi-space": ["error"] 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Intellij 2 | *.iml 3 | .idea 4 | 5 | # npm 6 | node_modules 7 | package-lock.json 8 | 9 | # Don't include the compiled main.js file in the repo. 10 | # They should be uploaded to GitHub releases instead. 11 | main.js 12 | 13 | # Exclude sourcemaps 14 | *.map 15 | 16 | # obsidian 17 | data.json 18 | dist/ 19 | -------------------------------------------------------------------------------- /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 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Obsidian Image Caption 2 | 3 | **This is currently an intermediate release with knowng issues.** 4 | 5 | ### Add captions to your images. 6 | 7 | ![Obsidian Image Caption example](https://raw.githubusercontent.com/bicarlsen/obsidian_image_caption/main/example.png) 8 | 9 | ## Use 10 | 11 | **Internal embeds** 12 | 13 | Use the pipe (|) after the the source of an embeded image to display the text as a caption of the figure. 14 | 15 | e.g. 16 | 17 | ```markdown 18 | ![[my_amazing_image.png|Check out this amazing picture.]] 19 | ``` 20 | 21 | **External embeds** 22 | 23 | Use alt text to display as a caption. 24 | 25 | Allows resizing of images, exactly how internal embeds work. (See below) 26 | 27 | e.g. 28 | 29 | ```markdown 30 | ![Another beautiful picture.](https://prettypicture.com/image01.png) 31 | ``` 32 | 33 | 34 | **Resizing** 35 | 36 | When resizing internally embedded images one can normally use the `x` after the pipe (`|`) character. Use the keyword `auto` as `` or `height` to set the size of one dimension and auto-scale the other. 37 | 38 | e.g. 39 | 40 | ```markdown 41 | ![[my_amazing_image.png|50x50]] 42 | ![[my_long_photo|autox200]] 43 | ``` 44 | 45 | You can now resize both internally and externally embeded images with caption. However, delimeters must be used to distinguish the caption text if it is present. 46 | 47 | e.g. If `"` is the caption delimeter. 48 | 49 | ```markdown 50 | ![[my_amazing_image.png|50x50]] 51 | 52 | ![[my_amazing_image.png|50x50 "Look at my caption ma!"]] 53 | 54 | !["I can caption anything!" 100x150](https://prettypicture.com/image01.png) 55 | 56 | ![100x150](https://prettypicture.com/image01.png) 57 | ``` 58 | 59 | ## Settings 60 | 61 | + **Label:** Text that prepends all captions.
62 | For automatic numbering use '#'. If a '#' character is meant to be output, escape it with a backslash ('\\'), i.e. '\\#'. Backslashes must also be escaped to be output, i.e.'\\\\'. 63 | 64 | + **CSS:** Apply custom CSS styling to the image captions.
65 | Captions are indexed from 1 using the 'data-image-caption-index' attribute for styling based on figure number. 66 | 67 | + **Delimeter:** Indicates the caption text.
68 | A delimeter is a set of characters that identify the caption text to use. The delimeter must enclose the text you wish to display as the caption. 69 | + If no delimeter is set the entire text is used. 70 | + A single delimeter can be used for the start and end.
71 | e.g. `"` -> `"My caption"` or `!!` -> `!!My caption!!` 72 | + A start and end delimter can be used by separating them with a comma (,).
73 | e.g. `{, }` -> `{My caption}` or `<<, >>` -> `<>` 74 | + **Note:** Whitespace is trimmed from the delimeter character sets. 75 | + **Note:** Only the first and last delimeters are matched, so the delimeter character can be used in the caption without special consideration, such as escaping. 76 | 77 | + **Caption as HTML:** Allows your captions to be rendered as HTML.
78 | By turning this option on your captions will be inserted into the document as HTML rather than text. 79 | 80 | ## FAQ 81 | 82 | + **My captions aren't showing up:** Captions are only added if the image is rerendered. Try changing the caption (needs to be more than a trailing space) and trying again. If this fixes the issue then change it back, otherwise open an Issue. 83 | 84 | + **How does this work with Panoc?:** Pandoc has an *implicit_figures* extension which is active by default. As the [User's Guide](https://pandoc.org/MANUAL.html#extension-implicit_figures) indicates: "\[a\]n image with nonempty alt text, occurring by itself in a paragraph, will be rendered as a figure with a caption. The image’s alt text will be used as the caption." This is identical to the behavior of this plugin for external embeds, though Pandoc ignores any resizing. 85 | 86 | ## Known issues 87 | 88 | + Some captions missing. 89 | + Not entirely compatible with Pandoc for exporting. 90 | -------------------------------------------------------------------------------- /build.md: -------------------------------------------------------------------------------- 1 | # Build 2 | 3 | ## Dev 4 | Run `npm run dev`. 5 | 6 | ## Release 7 | 1. Update plugin and Obsidian version info in `versions.json`, `manifest.json`, and `package.json`. 8 | 2. Git commit with version tag `x.y.z`. 9 | 3. Run `npm run build`. 10 | 4. Push changes to GitHub with tags. 11 | 5. Issue a new release on GitHub, include the built `main.js`, `styles.css`, and `maifest.json` files. -------------------------------------------------------------------------------- /esbuild.config.mjs: -------------------------------------------------------------------------------- 1 | /* 2 | * Taken from https://github.com/nothingislost/obsidian-cm6-attributes/blob/master/esbuild.config.mjs 3 | */ 4 | 5 | import esbuild from 'esbuild'; 6 | import process from 'process'; 7 | 8 | 9 | const prod = process.argv[2] === 'production'; 10 | const banner = `/* 11 | THIS FILE WAS GENERATED AUTOMATICALLY. 12 | You can view the source at https://github.com/bicarlsen/obsidian_image_caption. 13 | */` 14 | 15 | esbuild.build({ 16 | minify: prod ? true : false, 17 | banner: { 'js': banner }, 18 | entryPoints: [ 'src/main.ts' ], 19 | bundle: true, 20 | external: [ 21 | "obsidian", 22 | "codemirror", 23 | "@codemirror/view", 24 | "@codemirror/language" 25 | ], 26 | format: 'cjs', 27 | watch: !prod, 28 | target: 'es2016', 29 | logLevel: 'info', 30 | sourcemap: prod ? false : 'inline', 31 | treeShaking: true, 32 | outfile: 'main.js' 33 | }).catch( () => process.exit( 1 ) ); 34 | -------------------------------------------------------------------------------- /example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bicarlsen/obsidian_image_caption/84d92a2aaec8f601ad4f56084dad5e7c54eab8b8/example.png -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "obsidian-image-caption", 3 | "name": "Image Caption", 4 | "version": "0.0.15.alpha", 5 | "minAppVersion": "1.0.0", 6 | "description": "Add captions to images.", 7 | "author": "Brian Carlsen", 8 | "authorUrl": "https://github.com/bicarlsen", 9 | "isDesktopOnly": false 10 | } 11 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "obsidian-image-caption", 3 | "version": "0.0.15.alpha", 4 | "description": "Add captions to images in Obsidian.", 5 | "main": "main.js", 6 | "scripts": { 7 | "dev": "node esbuild.config.mjs", 8 | "build": "nod esbuild.config.mjs production" 9 | }, 10 | "keywords": [], 11 | "author": "", 12 | "license": "MIT", 13 | "dependencies": { 14 | "@codemirror/language": "6.0", 15 | "@codemirror/view": "6.0", 16 | "@types/node": "^18.0", 17 | "esbuild": "0.14", 18 | "obsidian": "^0.15", 19 | "tslib": "2.4", 20 | "typescript": "4.7" 21 | }, 22 | "devDependencies": { 23 | "@typescript-eslint/eslint-plugin": "^5.36.1", 24 | "@typescript-eslint/parser": "^5.36.1", 25 | "eslint": "^8.23.0" 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/common.ts: -------------------------------------------------------------------------------- 1 | import { 2 | MarkdownRenderChild 3 | } from 'obsidian'; 4 | 5 | import ImageCaptionPlugin from './main'; 6 | 7 | 8 | // ************* 9 | // *** types *** 10 | // ************* 11 | 12 | export interface ImageSize { 13 | width: number; 14 | height: number; 15 | } 16 | 17 | 18 | export interface ParsedCaption { 19 | text?: string; 20 | size?: ImageSize; 21 | } 22 | 23 | 24 | // ***************** 25 | // *** functions *** 26 | // ***************** 27 | 28 | 29 | /** 30 | * Get the nearest sibling matching the selector. 31 | * 32 | * @param {Element} elm - Element to start searching from. 33 | * @param {string} selector - Selector string. 34 | * @param {number} direction - Direction to search. 35 | * Negative to search previous, otherwise searches next. 36 | * @returns {Element} First element matching selector in the given direction. 37 | */ 38 | export function closestSibling( 39 | elm: Element, 40 | selector: string, 41 | direction?: number 42 | ): Element { 43 | const prev = (direction < 0); 44 | let sibling = prev ? elm.previousElementSibling : elm.nextElementSibling; 45 | while ( sibling && ! sibling.matches(selector) ) { 46 | sibling = prev ? sibling.previousElementSibling : sibling.nextElementSibling; 47 | } 48 | 49 | return sibling; 50 | } 51 | 52 | /** 53 | * Parses text to extract the caption and size for the image. 54 | * 55 | * @param text {string} Text to parse. 56 | * @param delimeter {string[]} Delimeter(s) used to indeicate caption text. 57 | * @returns { { caption: string, size?: ImageSize } } 58 | * An obect containing the caption text and size. 59 | */ 60 | export function parseCaptionText( text: string, delimeter: string[] ): ParsedCaption | null { 61 | if ( ! text ) { 62 | return null; 63 | } 64 | 65 | let start, end; 66 | let start_delim, end_delim; 67 | if ( delimeter.length === 0 ) { 68 | start_delim = ''; 69 | end_delim = ''; 70 | 71 | start = 0; 72 | end = text.length; 73 | } 74 | else if ( delimeter.length === 1 ) { 75 | // single delimeter character 76 | start_delim = delimeter[ 0 ]; 77 | end_delim = delimeter[ 0 ]; 78 | 79 | start = text.indexOf( start_delim ); 80 | end = text.lastIndexOf( end_delim ); 81 | } 82 | else if ( delimeter.length === 2 ) { 83 | // separate start and end delimeter 84 | start_delim = delimeter[ 0 ]; 85 | end_delim = delimeter[ 1 ]; 86 | 87 | start = text.indexOf( start_delim ); 88 | end = text.lastIndexOf( end_delim ); 89 | } 90 | else { 91 | // error 92 | return { 93 | text: undefined, 94 | size: undefined 95 | }; 96 | } 97 | 98 | // caption text 99 | let caption, remaining_text; 100 | if ( 101 | start === -1 || 102 | end === -1 || 103 | start === end 104 | ) { 105 | caption = undefined; 106 | remaining_text = [ text ]; 107 | } 108 | else { 109 | // exclude delimeters 110 | const start_offset = start_delim.length; 111 | const end_offset = end_delim.length 112 | 113 | caption = text.slice( start + start_offset, end ); 114 | remaining_text = [ 115 | text.slice( 0, start ), 116 | text.slice( end + end_offset ) 117 | ]; 118 | } 119 | 120 | // size 121 | let size = parseSize( remaining_text[ 0 ] ); 122 | if ( ! size && remaining_text[ 1 ] ) { 123 | size = parseSize( remaining_text[ 1 ] ); 124 | } 125 | 126 | return { text: caption, size }; 127 | } 128 | 129 | 130 | /** 131 | * Searches for a size parameter of the form 132 | * x returning the parameters if found. 133 | * 134 | * @param {string} text - Text to parse. 135 | * @returns {ImageSize|undefined} - Object representing the image size, 136 | * or undefined if not found. 137 | */ 138 | export function parseSize( text: string ): ImageSize { 139 | if ( ! text ) { 140 | return undefined; 141 | } 142 | 143 | const size_pattern = /(\d+|auto)x(\d+|auto)/i; 144 | const match = text.match( size_pattern ); 145 | if ( ! match ) { 146 | return undefined; 147 | } 148 | 149 | let width = parseInt(match[1]); 150 | let height = parseInt(match[2]); 151 | return { width, height }; 152 | } 153 | 154 | 155 | /** 156 | * Adds a caption to an image. 157 | * 158 | * @param {HTMLElement} target - Parent element for the caption. 159 | * @param {string} caption_text - Text to add for the caption. 160 | * @param {boolean} [asHtml=false] - Insert caption text as HTML rather than text. 161 | * @returns {MarkdownRenderChild} - Caption element that was added to the target as the caption. 162 | */ 163 | export function addCaption( 164 | target: HTMLElement, 165 | caption_text: string, 166 | asHtml: boolean = false 167 | ): MarkdownRenderChild { 168 | const caption = document.createElement( ImageCaptionPlugin.caption_tag ); 169 | caption.addClass( ImageCaptionPlugin.caption_class ); 170 | if ( asHtml ) { 171 | caption.innerHTML = caption_text; 172 | } 173 | else{ 174 | caption.innerText = caption_text; 175 | } 176 | 177 | target.appendChild( caption ); 178 | 179 | const style = getComputedStyle(target); 180 | if ( style.getPropertyValue('display') == 'inline' ) { 181 | target.style.display = 'inline-block'; 182 | } 183 | 184 | target.addClass('image-caption-captioned'); 185 | 186 | return new MarkdownRenderChild( caption ); 187 | } 188 | 189 | 190 | /** 191 | * Sets the width and height for an image. 192 | * 193 | * @param {HTMLElement} target - Parent element of the image. 194 | * @param {ImageSize} size - Width and height values. 195 | */ 196 | export function setSize( 197 | target: HTMLElement, 198 | size: ImageSize 199 | ) { 200 | const img = target.querySelector( 'img' ); 201 | const { width, height } = size; 202 | const w = width.toString(); 203 | const h = height.toString(); 204 | 205 | target.setAttribute( 'width', w ); 206 | target.setAttribute( 'height', h ); 207 | img.setAttribute( 'width', w ); 208 | img.setAttribute( 'height', h ); 209 | } 210 | 211 | 212 | /** 213 | * Updates index data for images. 214 | */ 215 | export function updateFigureIndices() { 216 | document.querySelectorAll( 'div.workspace-leaf' ).forEach( 217 | ( workspace: HTMLElement ) => { 218 | let index = 1; 219 | workspace.querySelectorAll( ImageCaptionPlugin.caption_selector ).forEach( 220 | ( el: HTMLElement ) => { 221 | el.dataset.imageCaptionIndex = index.toString(); 222 | index += 1; 223 | } 224 | ); 225 | } 226 | ); 227 | } 228 | 229 | -------------------------------------------------------------------------------- /src/index_widget.ts: -------------------------------------------------------------------------------- 1 | import { 2 | EditorView, 3 | WidgetType 4 | } from '@codemirror/view'; 5 | 6 | import { ParsedImage } from './state_parser'; 7 | 8 | 9 | export class ImageIndexWidget extends WidgetType { 10 | index: number; 11 | info: ParsedImage; 12 | 13 | constructor(index: number, info: ParsedImage) { 14 | super(); 15 | 16 | this.index = index; 17 | this.info = info; 18 | } 19 | 20 | toDOM(view: EditorView): HTMLElement { 21 | const container = document.createElement('data'); 22 | container.addClass('image-caption-data') 23 | container.setAttribute('data-image-caption-index', this.index.toString()); 24 | 25 | return container; 26 | } 27 | 28 | eq(other: ImageIndexWidget): boolean { 29 | return ( 30 | (other.index === this.index) 31 | && (other.info.embed_type === this.info.embed_type) 32 | ); 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | import { 2 | App, 3 | MarkdownView, 4 | Plugin, 5 | PluginSettingTab, 6 | Setting 7 | } from 'obsidian'; 8 | 9 | import { 10 | processInternalImageCaption, 11 | processExternalImageCaption, 12 | } from './md_processor'; 13 | 14 | import { processPreviewImageCaption } from './preview_processor'; 15 | import { viewObserver } from './view_observer'; 16 | 17 | interface ImageCaptionSettings { 18 | css: string; 19 | label: string; 20 | delimeter: string[]; 21 | htmlCaption: boolean; 22 | } 23 | 24 | const DEFAULT_SETTINGS: ImageCaptionSettings = { 25 | css: '', 26 | label: '', 27 | delimeter: [], 28 | htmlCaption: false, 29 | } 30 | 31 | 32 | export default class ImageCaptionPlugin extends Plugin { 33 | settings: ImageCaptionSettings; 34 | caption_observers: MutationObserver[]; 35 | stylesheet: HTMLElement; 36 | 37 | static caption_tag: string = 'figcaption'; 38 | static caption_class: string = 'obsidian-image-caption'; 39 | static caption_selector: string = `${ImageCaptionPlugin.caption_tag}.${ImageCaptionPlugin.caption_class}`; 40 | 41 | 42 | async onload() { 43 | await this.loadSettings(); 44 | 45 | // register processors for preview mode 46 | // const previewProcessor = processPreviewImageCaption( this ); 47 | // this.registerEditorExtension( previewProcessor ); 48 | 49 | const viewObs = viewObserver(this); 50 | this.registerEditorExtension(viewObs); 51 | 52 | // register processors for read mode 53 | this.caption_observers = []; 54 | // this.registerMarkdownPostProcessor( processInternalImageCaption( this ) ); 55 | // this.registerMarkdownPostProcessor( processExternalImageCaption( this ) ); 56 | 57 | this.addStylesheet(); 58 | this.addSettingTab( new ImageCaptionSettingTab( this.app, this ) ); 59 | } 60 | 61 | onunload() { 62 | if ( this.stylesheet ) { 63 | this.stylesheet.remove(); 64 | } 65 | 66 | // this.clearObservers(); 67 | // this.removeCaptions(); 68 | } 69 | 70 | async loadSettings() { 71 | this.settings = Object.assign( {}, DEFAULT_SETTINGS, await this.loadData() ); 72 | } 73 | 74 | async saveSettings() { 75 | await this.saveData( this.settings ); 76 | } 77 | 78 | addObserver( observer: MutationObserver ) { 79 | this.caption_observers.push( observer ); 80 | } 81 | 82 | removeObserver( observer: MutationObserver ) { 83 | observer.disconnect(); 84 | const index = this.caption_observers.indexOf( observer ); 85 | this.caption_observers.splice( index, 1 ); 86 | } 87 | 88 | clearObservers() { 89 | for ( const observer of this.caption_observers ) { 90 | observer.disconnect(); 91 | } 92 | 93 | this.caption_observers = []; 94 | } 95 | 96 | addStylesheet() { 97 | this.stylesheet = document.createElement('style'); 98 | this.stylesheet.setAttribute('type', 'text/css'); 99 | this.updateStylesheet(); 100 | document.head.append(this.stylesheet); 101 | } 102 | 103 | updateStylesheet() { 104 | const css = this.settings.css ? `${ImageCaptionPlugin.caption_selector} { ${this.settings.css} }` : ''; 105 | 106 | let label = this.settings.label; 107 | if ( label ) { 108 | // replace all unescaped hashtags with image index 109 | const number_pattern = /(^|[^\\])#/g; 110 | label = label.replace( number_pattern, "$1' attr(data-image-caption-fignum) '" ); // inner quotes used to kill string and insert attr. + between strings breaks it. 111 | 112 | // Replace escaped hashtags with hashtags 113 | label = label.replace( '\\#', '#' ); 114 | 115 | label = `${ImageCaptionPlugin.caption_selector}::before { content: '${label} ' }`; // additional space in content intentional 116 | } 117 | 118 | this.stylesheet.innerText = `${css} ${label}`; 119 | } 120 | 121 | removeCaptions() { 122 | const captions: NodeList = document.querySelectorAll( ImageCaptionPlugin.caption_selector ) 123 | captions.forEach( ( caption: HTMLElement ) => { 124 | caption.remove(); 125 | } ); 126 | } 127 | } // end ImageCaptionPlugin 128 | 129 | 130 | class ImageCaptionSettingTab extends PluginSettingTab { 131 | plugin: ImageCaptionPlugin; 132 | 133 | constructor( app: App, plugin: ImageCaptionPlugin ) { 134 | super( app, plugin ); 135 | this.plugin = plugin; 136 | } 137 | 138 | display(): void { 139 | let { containerEl } = this; 140 | containerEl.empty(); 141 | 142 | // label 143 | new Setting( containerEl ) 144 | .setName( 'Label' ) 145 | .setDesc( 'Prepend this text before each caption.' ) 146 | .addText( ( text ) => text 147 | .setPlaceholder( 'Label' ) 148 | .setValue( this.plugin.settings.label ) 149 | .onChange( async ( value ) => { 150 | this.plugin.settings.label = value.trim(); 151 | await this.plugin.saveSettings(); 152 | this.plugin.updateStylesheet(); 153 | } ) 154 | ); 155 | 156 | // css 157 | new Setting( containerEl ) 158 | .setName( 'CSS' ) 159 | .setDesc( 'Custom CSS styling for captions.' ) 160 | .addTextArea( ( text ) => text 161 | .setPlaceholder('Enter your CSS' ) 162 | .setValue( this.plugin.settings.css ) 163 | .onChange( async ( value ) => { 164 | this.plugin.settings.css = value.trim(); 165 | await this.plugin.saveSettings(); 166 | this.plugin.updateStylesheet(); 167 | } ) 168 | ); 169 | 170 | // delimeter 171 | const delimeter = new Setting( containerEl ) 172 | .setName( 'Delimeter' ) 173 | .setDesc( 174 | 'Identify the caption by surrounding it with the delimeter. ' + 175 | 'Start and end delimeters mays be specified by separation with a comma (,).' 176 | ) 177 | .setTooltip( 178 | 'If no delimeter is provided the entire alt text is taken to be the caption. ' + 179 | 'If a single delimeter is specified it must indicate the start and end of the caption. ' + 180 | 'If two delimeters are specified, by separation with a comma, the caption is taken to be ' + 181 | 'the text between the start and end delimeters.' 182 | ); 183 | 184 | delimeter.addText( ( text ) => text 185 | .setPlaceholder( 'Delimeter' ) 186 | .setValue( this.plugin.settings.delimeter.join( ', ' ) ) 187 | .onChange( async ( value ) => { 188 | let delimeters = value.split( ',' ).map( d => d.trim() ); 189 | 190 | // validate setting 191 | if ( delimeters.length > 2 ) { 192 | // too many delimeters 193 | delimeter.controlEl.addClass( 'setting-error' ); 194 | return; 195 | } 196 | 197 | if ( delimeters.length === 2 && delimeters.some( d => !d ) ) { 198 | // empty delimeter 199 | delimeter.controlEl.addClass( 'setting-error' ); 200 | return; 201 | } 202 | 203 | // delimeters valid 204 | if ( delimeters.length === 1 && delimeters[ 0 ] === '' ) { 205 | // no delimeter specified 206 | delimeters = []; 207 | } 208 | 209 | delimeter.controlEl.removeClass( 'setting-error' ); 210 | this.plugin.settings.delimeter = delimeters; 211 | await this.plugin.saveSettings(); 212 | } ) 213 | ); 214 | 215 | // parse html 216 | new Setting( containerEl ) 217 | .setName( 'Caption as HTML' ) 218 | .setDesc( 'Insert caption text as HTML.' ) 219 | .addToggle( ( toggle ) => toggle 220 | .setValue( this.plugin.settings.htmlCaption ) 221 | .onChange( async ( value ) => { 222 | this.plugin.settings.htmlCaption = value; 223 | await this.plugin.saveSettings(); 224 | } ) 225 | ); 226 | 227 | } // end #display 228 | } 229 | -------------------------------------------------------------------------------- /src/preview_processor.ts: -------------------------------------------------------------------------------- 1 | import { 2 | SyntaxNodeRef 3 | } from '@lezer/common'; 4 | 5 | import { 6 | Range, 7 | RangeSetBuilder, 8 | EditorState, 9 | StateField, 10 | Extension, 11 | Transaction 12 | } from '@codemirror/state'; 13 | 14 | import { 15 | PluginValue, 16 | ViewPlugin, 17 | EditorView, 18 | ViewUpdate, 19 | WidgetType, 20 | Decoration, 21 | DecorationSet 22 | } from '@codemirror/view'; 23 | 24 | import { syntaxTree } from '@codemirror/language'; 25 | 26 | import ImageCaptionPlugin from './main'; 27 | import { 28 | parseCaptionText, 29 | addCaption, 30 | setSize, 31 | updateFigureIndices, 32 | } from './common'; 33 | 34 | import { StateParser, ParsedImage } from './state_parser'; 35 | 36 | 37 | // ******************* 38 | // *** Definitions *** 39 | // ******************* 40 | 41 | /** 42 | * Alias for arguments needed to create a decoration. 43 | */ 44 | type RangeSetBuilderArgs = { from: number, to: number, value: Decoration} 45 | 46 | 47 | /** 48 | * Id of the `node.type.props` storing relevant information. 49 | */ 50 | const NODE_TYPE_PROP_ID = 11; 51 | 52 | 53 | // ******************* 54 | // *** Decorations *** 55 | // ******************* 56 | 57 | /** 58 | * Widget decoration to provide the image caption. 59 | */ 60 | class ImageCaptionWidget extends WidgetType { 61 | caption: string; 62 | index: number; 63 | 64 | /** 65 | * @param {string} caption - Caption to display. 66 | */ 67 | constructor(caption: string, index: number) { 68 | super(); 69 | this.caption = caption; 70 | this.index = index; 71 | } 72 | 73 | eq(other: ImageCaptionWidget): boolean { 74 | return ( 75 | (other.caption === this.caption) 76 | && (other.index === this.index) 77 | ); 78 | } 79 | 80 | toDOM(view: EditorView): HTMLElement { 81 | const cap = document.createElement('figcaption') 82 | cap.innerHTML = this.caption; 83 | cap.dataset.imageCaptionIndex = this.index.toString(); 84 | cap.addClass(ImageCaptionPlugin.caption_class); 85 | 86 | return cap; 87 | } 88 | 89 | ignoreEvent(): boolean { 90 | return false; 91 | } 92 | } 93 | 94 | 95 | /** 96 | * Mark decoration to alter the image. 97 | */ 98 | function createCaptionedImageMark(): Decoration { 99 | return Decoration.mark({ 100 | inclusive: true, 101 | attributes: { 102 | class: 'image_with_caption' 103 | } 104 | }); 105 | } 106 | 107 | 108 | // ******************* 109 | // *** View Plugin *** 110 | // ******************* 111 | 112 | /** 113 | * @todo Should proabably be structured in a better way, perhaps by using a StateField? 114 | * 115 | * Factory function allowing access to the plugin. 116 | */ 117 | export function previewImageCaptionParserFactory(plugin: ImageCaptionPlugin) { 118 | return class PreviewImageCaptionParser implements PluginValue { 119 | parser: StateParser; 120 | decorations: DecorationSet; 121 | state_fields: Extension[]; 122 | 123 | constructor( view: EditorView ) { 124 | this.parser = new StateParser(plugin); 125 | this.decorations = this.build_decorations(view.state); 126 | } 127 | 128 | /** 129 | * Create all decoration for the current editor state. 130 | * 131 | * @param {EditorState} editor - Current editor state. 132 | * @returns {DecorationSet} All decorations for the current editor state. 133 | */ 134 | build_decorations(state: EditorState): DecorationSet { 135 | const deco_builder = new RangeSetBuilder(); 136 | const images = this.parser.parse(state); 137 | 138 | // imgs.forEach((img) => console.log(img.getAttribute('src'))) 139 | for( let i = 0; i < images.length; i++ ) { 140 | const img = images[i]; 141 | 142 | // // image 143 | // const start = img.nodes.at(0).from; 144 | // const end = img.nodes.at(-1).to; 145 | // const captioned_image_deco = createCaptionedImageMark(); 146 | // deco_builder.add(start, end, captioned_image_deco); 147 | 148 | // caption 149 | const pos = img.nodes.at(-1).to; 150 | const caption_marker = Decoration.widget({ 151 | widget: new ImageCaptionWidget(img.caption, i) 152 | }); 153 | 154 | deco_builder.add(pos, pos, caption_marker); 155 | } 156 | 157 | const live_obs = new MutationObserver( 158 | ( mutations: MutationRecord[], observer: MutationObserver ) => { 159 | mutations.forEach((rec: MutationRecord) => { 160 | if ( rec.type === 'childList' ) { 161 | // console.log(mutations) 162 | const imgs = rec.target.querySelectorAll('img:not(.cm-widgetBuffer)'); 163 | // console.log(imgs) 164 | 165 | if ( rec.addedNodes.length ) { 166 | 167 | } 168 | 169 | if ( rec.removedNodes.length ) { 170 | 171 | } 172 | } 173 | 174 | }); 175 | } 176 | ); 177 | 178 | const live_preview = document.querySelector('.markdown-source-view.is-live-preview'); 179 | const reader_view = document.querySelector('.markdown-reading-view'); 180 | // live_obs.observe(live_preview, { 181 | // subtree: true, 182 | // childList: true, 183 | // attributeFilter: [ 'class' ] 184 | // }); 185 | 186 | 187 | 188 | return deco_builder.finish(); 189 | } 190 | 191 | update( update: ViewUpdate ) { 192 | if ( ! update.docChanged ) { 193 | return; 194 | } 195 | 196 | // captions 197 | const decos = this.build_decorations(update.state); 198 | this.decorations = decos; 199 | 200 | // fig sizes 201 | // const imgs = document.querySelectorAll('img'); 202 | // imgs.forEach( (img: HTMLElement) => { 203 | // const alt_text = img.getAttribute( 'alt' ); 204 | // const delimeter = plugin.settings.delimeter; 205 | // const parsed = parseCaptionText( alt_text, delimeter ); 206 | 207 | // if( !parsed ) { 208 | // return; 209 | // } 210 | 211 | // const size = parsed.size; 212 | // const caption = parsed.text; 213 | 214 | // if( !size ) { 215 | // return; 216 | // } 217 | 218 | // const w = size.width.toString(); 219 | // const h = size.height.toString(); 220 | // img.setAttribute( 'width', w ); 221 | // img.setAttribute( 'height', h ); 222 | // }); 223 | } 224 | 225 | destroy() { 226 | } 227 | } 228 | } 229 | 230 | 231 | export function processPreviewImageCaption( 232 | plugin: ImageCaptionPlugin 233 | ): Extension { 234 | 235 | const view_plug = ViewPlugin.fromClass( 236 | previewImageCaptionParserFactory(plugin), 237 | { 238 | decorations: view_plug => view_plug.decorations 239 | } 240 | ); 241 | 242 | return [ 243 | view_plug 244 | ]; 245 | } 246 | -------------------------------------------------------------------------------- /src/reader_observer.ts: -------------------------------------------------------------------------------- 1 | import { 2 | MarkdownPostProcessorContext, 3 | MarkdownRenderChild 4 | } from 'obsidian'; 5 | 6 | import ImageCaptionPlugin from './main'; 7 | import { 8 | parseCaptionText, 9 | addCaption, 10 | setSize, 11 | updateFigureIndices 12 | } from './common'; 13 | 14 | /** 15 | * Registers a Mutation Observer on an image to add a caption. 16 | * The observer is unregistered after the caption has been added. 17 | * Meant to be used for internal embeds. 18 | * 19 | * @param plugin {ImageCaptionPlugin} 20 | * @param ctx {MarkdownPostProcessorContext} 21 | * @returns {MutationObserver} 22 | */ 23 | export function internalCaptionObserver( 24 | plugin: ImageCaptionPlugin, 25 | ctx: MarkdownPostProcessorContext 26 | ): MutationObserver { 27 | return new MutationObserver( ( mutations: MutationRecord[], observer: MutationObserver ) => { 28 | for ( const mutation of mutations ) { 29 | const target = mutation.target as HTMLElement; 30 | if ( !target.matches( 'span.image-embed' ) ) { 31 | continue; 32 | } 33 | 34 | let caption_text = target.getAttribute( 'alt' ); 35 | if ( caption_text === target.getAttribute( 'src' ) ) { 36 | // default caption, skip 37 | continue; 38 | } 39 | 40 | if ( target.querySelector( ImageCaptionPlugin.caption_selector ) ) { 41 | // caption already added 42 | continue; 43 | } 44 | 45 | if ( ! caption_text ) { 46 | continue; 47 | } 48 | 49 | const parsed = parseCaptionText( caption_text, plugin.settings.delimeter ); 50 | const size = parsed.size; 51 | caption_text = parsed.text; 52 | 53 | if ( caption_text ) { 54 | const caption = addCaption( 55 | target, 56 | caption_text, 57 | plugin.settings.htmlCaption 58 | ); 59 | ctx.addChild( caption ); 60 | 61 | target.addClass( 'with_image_caption' ); 62 | } 63 | 64 | if ( size ) { 65 | setSize( target, size ); 66 | } 67 | } // end for..of 68 | 69 | updateFigureIndices(); 70 | plugin.removeObserver( observer ); 71 | } ); 72 | } 73 | 74 | 75 | /** 76 | * Registers a Mutation Observer on an image to add a caption. 77 | * The observer is unregistered after the caption has been added. 78 | * Meant to be used for external embeds. 79 | * 80 | * @param plugin {ImageCaptionPlugin} 81 | * @returns {MutationObserver} 82 | */ 83 | export function externalCaptionObserver( 84 | plugin: ImageCaptionPlugin 85 | ): MutationObserver { 86 | return new MutationObserver( ( mutations, observer ) => { 87 | let update = false; 88 | for ( const mutation of mutations ) { 89 | const captions = [ ...mutation.addedNodes ].filter( 90 | ( elm: HTMLElement ) => { 91 | return elm.matches(ImageCaptionPlugin.caption_selector); 92 | } 93 | ); 94 | 95 | if ( captions.length ) { 96 | // new caption exists 97 | update = true; 98 | } 99 | } 100 | 101 | if (update) { 102 | updateFigureIndices(); 103 | plugin.removeObserver(observer); 104 | } 105 | } ); 106 | } 107 | 108 | 109 | /** 110 | * Registers MutationObservers on internal images. 111 | * 112 | * @param {ImageCaptionPlugin} plugin 113 | * @returns {(HTMLElement, MarkdownPostProcessorContext) => void} 114 | * Function that registers internal images to have a caption added to them. 115 | */ 116 | export function processInternalImageCaption( 117 | plugin: ImageCaptionPlugin 118 | ): ( el: HTMLElement, ctx: MarkdownPostProcessorContext ) => void { 119 | 120 | return function ( 121 | el: HTMLElement, 122 | ctx: MarkdownPostProcessorContext 123 | ): void { 124 | console.log(el) 125 | el.querySelectorAll( 'span.internal-embed.image-embed' ).forEach( 126 | ( container: HTMLElement ) => { 127 | // must listen for class changes because images 128 | // may be loaded after this run 129 | const observer = internalCaptionObserver( plugin, ctx ); 130 | observer.observe( 131 | container, 132 | { attributes: true, attributeFilter: [ 'class' ] } 133 | ); 134 | 135 | plugin.addObserver( observer ); 136 | } 137 | ); 138 | }; 139 | } 140 | 141 | 142 | /** 143 | * Adds caption to external images. 144 | * 145 | * @param {ImageCaptionPlugin} plugin 146 | * @returns {(HTMLElement, MarkdownPostProcessorContext) => void} 147 | * Function that registers external images to have a caption added to them. 148 | */ 149 | export function processExternalImageCaption( 150 | plugin: ImageCaptionPlugin 151 | ): ( el: HTMLElement, ctx: MarkdownPostProcessorContext ) => void { 152 | 153 | return function ( 154 | el: HTMLElement, 155 | ctx: MarkdownPostProcessorContext 156 | ): void { 157 | const container_css_class = 'obsidian-image-caption-external-embed'; 158 | 159 | const elms = el.querySelectorAll( 'img' ); 160 | elms.forEach( 161 | ( elm: HTMLElement ) => { 162 | if( elm.closest( 'span.internal-embed' ) ) { 163 | // filter out internal images 164 | return; 165 | } 166 | 167 | const img = elm; 168 | if (img.closest(`.${container_css_class}`)) { 169 | // caption already added 170 | return; 171 | } 172 | 173 | // @todo: External images no longer have alt text. 174 | // Need to find another way to add caption. 175 | let caption_text = img.getAttribute( 'alt' ); 176 | if ( ! caption_text ) { 177 | return; 178 | } 179 | 180 | const parsed = parseCaptionText( 181 | caption_text, 182 | plugin.settings.delimeter 183 | ); 184 | 185 | const size = parsed.size; 186 | caption_text = parsed.text; 187 | if ( !( caption_text || size ) ) { 188 | return; 189 | } 190 | 191 | // create container 192 | const container = document.createElement( 'span' ); 193 | container.addClass( container_css_class ); 194 | 195 | // observe container for caption to be added 196 | const observer = externalCaptionObserver( plugin ); 197 | observer.observe( 198 | container, 199 | { childList: true } 200 | ); 201 | 202 | plugin.addObserver( observer ); 203 | 204 | // insert container into DOM 205 | img.replaceWith( container ); 206 | container.appendChild( img ); 207 | 208 | // add caption 209 | if ( caption_text ) { 210 | const caption = addCaption( 211 | container, 212 | caption_text, 213 | plugin.settings.htmlCaption 214 | ); 215 | 216 | ctx.addChild( new MarkdownRenderChild( container ) ); 217 | ctx.addChild( caption ); 218 | } 219 | 220 | // set size 221 | if ( size ) { 222 | setSize( container, size ); 223 | } 224 | } 225 | ); 226 | }; 227 | } 228 | -------------------------------------------------------------------------------- /src/state_parser.ts: -------------------------------------------------------------------------------- 1 | import { 2 | SyntaxNodeRef 3 | } from '@lezer/common'; 4 | 5 | import { 6 | Range, 7 | RangeSetBuilder, 8 | EditorState, 9 | StateField, 10 | Extension, 11 | Transaction 12 | } from '@codemirror/state'; 13 | 14 | import { 15 | PluginValue, 16 | ViewPlugin, 17 | EditorView, 18 | ViewUpdate, 19 | WidgetType, 20 | Decoration, 21 | DecorationSet 22 | } from '@codemirror/view'; 23 | 24 | import { syntaxTree } from '@codemirror/language'; 25 | 26 | import ImageCaptionPlugin from './main'; 27 | import { 28 | ImageSize, 29 | ParsedCaption, 30 | parseCaptionText, 31 | addCaption, 32 | setSize, 33 | updateFigureIndices, 34 | } from './common'; 35 | 36 | 37 | // ******************* 38 | // *** Definitions *** 39 | // ******************* 40 | 41 | /** 42 | * Holds information about a parsed image. 43 | * 44 | * + nodes: List of nodes representing the entire image. 45 | * + src: Image source URI 46 | * + caption: Image caption, if it exists 47 | * + size: A size object of {width: number, height: number} of the desired dimensions, 48 | * if it exists. 49 | * + embed_type: String indicating the type of embed. 50 | * Values are ['internal', 'external'] 51 | */ 52 | export interface ParsedImage { 53 | nodes: SyntaxNodeRef[]; 54 | src: string; 55 | caption?: string; 56 | size?: ImageSize; 57 | embed_type: EmbedType; 58 | } 59 | 60 | /** 61 | * Type of embed. 62 | */ 63 | export enum EmbedType { 64 | Internal = 'internal', 65 | External = 'external', 66 | } 67 | 68 | /** 69 | * Id of the `node.type.props` storing relevant information. 70 | */ 71 | const NODE_TYPE_PROP_ID = 11; 72 | 73 | 74 | // ************************ 75 | // *** Common Functions *** 76 | // ************************ 77 | 78 | /** 79 | * @param {SyntaxNodeRef[]} nodes - List of nodes to extract text between. 80 | * @param {EditorState} state - Editor state containing the DOM. 81 | * @returns {string} Text between the first and last nodes. 82 | */ 83 | function nodes_text(nodes: SyntaxNodeRef[], state: EditorState): string { 84 | return state.doc.slice( 85 | nodes.at(0).from, 86 | nodes.at(-1).to 87 | ).toString(); 88 | } 89 | 90 | /** 91 | * @param {SyntaxNodeRef} node - Node to get properties of. 92 | * @returns {string[]} Array of the node's props. 93 | */ 94 | function node_props(node: SyntaxNodeRef): string[] { 95 | const props = node.type ? node.type.props : node.props; 96 | const prop_list = props[NODE_TYPE_PROP_ID]; 97 | if( prop_list === undefined ) { 98 | return []; 99 | } 100 | 101 | return prop_list.split(' '); 102 | } 103 | 104 | /** 105 | * @param {string} prop - Prop to check for. 106 | * @param {SyntaxNodeRef} node - Node to check. 107 | * @returns {boolean} If the node has the given prop. 108 | */ 109 | function node_has_prop(prop: string, node: SyntaxNodeRef): boolean { 110 | const props = node_props(node); 111 | return props.contains(prop); 112 | } 113 | 114 | /** 115 | * Collect nodes until the given stopping condition is met. 116 | * 117 | * @param {SytnaxNodeRef} start_node - Node to begin at. 118 | * @param {(node: SyntaxNodeRef, nodes?: SyntaxNodeRef[]) => boolean} stop - 119 | * Function used to determine when to stop. 120 | * The function should accept a node, which ws the last added, and can 121 | * optionally accept the entire array of nodes. 122 | * The function should return true when collection should stop, 123 | * otherwise collection will stop at the end of the current tree. 124 | * @returns {SyntaxNodeRef[]} Array of nodes including the start and stop node. 125 | */ 126 | function collect_nodes_until( 127 | start_node: SyntaxNodeRef, 128 | stop: (node: SyntaxNodeRef, nodes?: SyntaxNodeRef[]) => boolean 129 | ): SyntaxNodeRef[] { 130 | const nodes = [start_node]; 131 | while( ! stop(nodes.at(-1), nodes) ) { 132 | const next = nodes.at(-1).node.nextSibling; 133 | if ( ! next ) { 134 | break; 135 | } 136 | nodes.push(next); 137 | } 138 | 139 | return nodes; 140 | } 141 | 142 | /** 143 | * @param {SyntaxNodeRef} node - Node to check. 144 | * @return {boolean} Whether the node represents the start of an internally embedded image. 145 | */ 146 | function node_is_embed_start(node: SyntaxNodeRef): boolean { 147 | const prop_id = 'formatting-link-start'; 148 | return node_has_prop(prop_id, node); 149 | } 150 | 151 | /** 152 | * @param {SyntaxNodeRef} node - Node to check. 153 | * @return {boolean} Whether the node represents the end of an internally embedded image. 154 | */ 155 | function node_is_embed_end(node: SyntaxNodeRef): boolean { 156 | const prop_id = 'formatting-link-end'; 157 | return node_has_prop(prop_id, node); 158 | } 159 | 160 | /** 161 | * @param {SyntaxNodeRef} node - Node to check. 162 | * @return {boolean} Whether the node represents the start of an externally embedded image. 163 | */ 164 | function node_is_image_start(node: SyntaxNodeRef): boolean { 165 | const prop_id = 'image-marker'; 166 | return node_has_prop(prop_id, node); 167 | } 168 | 169 | /** 170 | * @param {SyntaxNodeRef} node - Node to check. 171 | * @return {boolean} Whether the node represents the end of an externally embedded image. 172 | */ 173 | function node_is_image_end(node: SyntaxNodeRef, nodes: SyntaxNodeRef[]): boolean { 174 | const prop_id = 'formatting-link-string'; 175 | const is_marker = nodes.map( n => ( node_has_prop(prop_id, n) ? 1 : 0 ) ); 176 | const num_markers = is_marker.reduce( (sum, val ) => ( sum + val ), 0 ); 177 | 178 | return (num_markers == 2); 179 | } 180 | 181 | /** 182 | * @param {SyntaxNodeRef} node - Node to check. 183 | * @return {boolean} Whether the node has alt text. 184 | */ 185 | function node_has_alt_text(node: SyntaxNodeRef): boolean { 186 | const prop_id = 'link-has-alias'; 187 | return node_has_prop(prop_id, node); 188 | } 189 | 190 | /** 191 | * @param {SyntaxNodeRef} node - Node to check. 192 | * @return {boolean} Whether the node is part of the alt text. 193 | */ 194 | function node_is_alt_text(node: SyntaxNodeRef): boolean { 195 | const int_prop_id = 'link-alias'; 196 | const ext_prop_id = 'image-alt-text'; 197 | return ( 198 | node_has_prop(int_prop_id, node) 199 | || node_has_prop(ext_prop_id, node) 200 | ); 201 | } 202 | 203 | /** 204 | * @param {SyntaxNodeRef} node - Node to check. 205 | * @return {boolean} Whether the node contains the source of an internally embedded image. 206 | */ 207 | function node_is_embed_src(node: SyntaxNodeRef): boolean { 208 | const prop_id = 'hmd-internal-link'; 209 | return node_has_prop(prop_id, node); 210 | } 211 | 212 | /** 213 | * @param {SyntaxNodeRef} node - Node to check. 214 | * @return {boolean} Whether the node contains the source of an externally embeded image. 215 | */ 216 | function node_is_image_src(node: SyntaxNodeRef): boolean { 217 | const prop_id = 'url'; 218 | return node_has_prop(prop_id, node); 219 | } 220 | 221 | 222 | // ************** 223 | // *** Parser *** 224 | // ************** 225 | 226 | 227 | export class StateParser { 228 | plugin: ImageCaptionPlugin; 229 | 230 | /** 231 | * @param {ImageCaptionPlugin} plugin - Plugin instance to use for parsing settings. 232 | */ 233 | constructor(plugin: ImageCaptionPlugin) { 234 | this.plugin = plugin; 235 | } 236 | 237 | /** 238 | * Parses an editor state returning a list of parsed images. 239 | * 240 | * @param {EditorState} state: Editor state to parse. 241 | * @returns {ParsedImage[]} List of parsed images. 242 | */ 243 | parse(state: EditorState): ParsedImage[] { 244 | const tree = syntaxTree(state); 245 | const images: ParsedImage[] = []; 246 | let embed_type: EmbedType; 247 | 248 | tree.iterate({ 249 | enter: (node: SyntaxNodeRef): boolean => { 250 | let nodes; 251 | if ( node_is_embed_start(node) ) { 252 | console.debug(node); 253 | nodes = collect_nodes_until(node, node_is_embed_end); 254 | embed_type = EmbedType.Internal; 255 | } 256 | else if ( node_is_image_start(node) ) { 257 | nodes = collect_nodes_until(node, node_is_image_end); 258 | embed_type = EmbedType.External; 259 | } 260 | else { 261 | // not an image, do nothing, recurse on children 262 | return true; 263 | } 264 | 265 | const src = this.parse_nodes_src( nodes, state ); 266 | let caption_info = this.parse_nodes_caption( nodes, state ); 267 | if ( ! caption_info ) { 268 | caption_info = { 269 | text: undefined, 270 | size: undefined 271 | }; 272 | } 273 | 274 | const image: ParsedImage = { 275 | nodes, 276 | src, 277 | caption: caption_info.text, 278 | size: caption_info.size, 279 | embed_type 280 | }; 281 | 282 | images.push(image); 283 | return false; // prevent recursing on children 284 | } 285 | }); 286 | 287 | return images; 288 | } 289 | 290 | /** 291 | * Parse caption from nodes. 292 | * 293 | * @param {SyntaxNodeRef[]} nodes - List of nodes representing the image. 294 | * @param {EditorState} state - Current editor state. 295 | * @returns {string} Image's source URI. 296 | * @throws {Error} If the nodes' source could not be determined. 297 | */ 298 | parse_nodes_src( 299 | nodes: SyntaxNodeRef[], 300 | state: EditorState 301 | ): string { 302 | let src_nodes; 303 | src_nodes = nodes.filter(node_is_embed_src); 304 | if ( src_nodes.length ) { 305 | // internal embed 306 | const src_text = nodes_text(src_nodes, state); 307 | const src_parts = src_text.split('|').map( 308 | (pt: string) => { 309 | return pt.trim(); 310 | } 311 | ); 312 | 313 | return src_parts[0]; 314 | } 315 | 316 | src_nodes = nodes.filter(node_is_image_src); 317 | if ( !src_nodes.length ) { 318 | throw Error('Could not find source for nodes.'); 319 | } 320 | 321 | // external embed 322 | let src_text = nodes_text(src_nodes, state).trim(); 323 | 324 | // strip beginning and end 325 | src_text = src_text.slice(1, -1); 326 | return src_text; 327 | } 328 | 329 | 330 | /** 331 | * Parse caption from nodes. 332 | * 333 | * @param {SyntaxNodeRef[]} nodes - List of nodes representing the image. 334 | * @param {EditorState} state - Current editor state. 335 | * @returns {ParsedCaption | null} Parsed caption information or null if none exists. 336 | */ 337 | parse_nodes_caption( 338 | nodes: SyntaxNodeRef[], 339 | state: EditorState 340 | ): ParsedCaption | null { 341 | const alt_nodes = nodes.filter(node_is_alt_text); 342 | if ( ! alt_nodes.length ) { 343 | return null; 344 | } 345 | 346 | const alt_text = state.sliceDoc( alt_nodes.at(0).from, alt_nodes.at(-1).to ); 347 | const delimeter = this.plugin.settings.delimeter; 348 | return parseCaptionText( alt_text, delimeter ); 349 | } 350 | } 351 | -------------------------------------------------------------------------------- /src/view_observer.ts: -------------------------------------------------------------------------------- 1 | import { 2 | SyntaxNodeRef 3 | } from '@lezer/common'; 4 | 5 | import { 6 | Range, 7 | RangeSetBuilder, 8 | EditorState, 9 | Extension, 10 | Transaction 11 | } from '@codemirror/state'; 12 | 13 | import { 14 | PluginValue, 15 | ViewPlugin, 16 | EditorView, 17 | ViewUpdate, 18 | WidgetType, 19 | Decoration, 20 | DecorationSet 21 | } from '@codemirror/view'; 22 | 23 | import ImageCaptionPlugin from './main'; 24 | import { closestSibling, addCaption, setSize } from './common'; 25 | import { StateParser, ParsedImage, EmbedType } from './state_parser'; 26 | import { ImageIndexWidget } from './index_widget'; 27 | 28 | // ******************* 29 | // *** View Plugin *** 30 | // ******************* 31 | 32 | /** 33 | * @todo Should proabably be structured in a better way, perhaps by using a StateField? 34 | * 35 | * Factory function allowing access to the plugin. 36 | * 37 | * @returns {ImageCaptionParser} Parser class to contruct a View Plugin 38 | * for CodeMirror using ViewPlugin#fromClass. 39 | */ 40 | export function ViewObserverFactory(plugin: ImageCaptionPlugin) { 41 | return class ImageCaptionParser implements PluginValue { 42 | parser: StateParser; 43 | image_info: ParsedImage[]; 44 | observers: MutationObserver[]; 45 | decorations: DecorationSet; 46 | 47 | constructor( view: EditorView ) { 48 | this.parser = new StateParser(plugin); 49 | this.observers = []; 50 | 51 | this.image_info = this.parser.parse(view.state); 52 | this.decorations = this.mark_images(this.image_info); 53 | this.register_observers(view, this.image_info); 54 | } 55 | 56 | /** 57 | * Update captions when the document state has changed. 58 | */ 59 | update(update: ViewUpdate) { 60 | this.image_info = this.parser.parse(update.state); 61 | if (update.docChanged) { 62 | this.decorations = this.mark_images(this.image_info); 63 | this.register_observers(update.view, this.image_info); 64 | } 65 | else if (update.viewportChanged) { 66 | this.register_observers(update.view, this.image_info); 67 | } 68 | } 69 | 70 | destroy() { 71 | this.clear_observers(); 72 | } 73 | 74 | /** 75 | * Creates image marker decorations. 76 | * 77 | * @param {ParsedImage[]} images - List of parsed images. 78 | * @returns {DecorationSet} Decoration to mark images. 79 | */ 80 | mark_images(images: ParsedImage[]): DecorationSet { 81 | const decos = []; 82 | for (let i = 0; i < images.length; i++) { 83 | const img = images[i]; 84 | const dec = Decoration.widget( { 85 | widget: new ImageIndexWidget(i, img), 86 | side: 9999 // place marker as last decoration to ensure image is above, marker must be placed after image for control. 87 | } ); 88 | 89 | const pos = img.nodes.at(-1).to; 90 | decos.push(dec.range(pos)); 91 | } 92 | 93 | return Decoration.set(decos); 94 | } 95 | 96 | /** 97 | * Register observers for each view. 98 | * 99 | * @param {EditorView} view - CodeMirror editor view. 100 | * @param {ParsedImage[]} images - Parsed images from the document. 101 | */ 102 | register_observers(view: EditorView, images: ParsedImage[]) { 103 | const {preview, source, reading} = this.parse_views(view.root); 104 | if (preview) { 105 | this.register_preview_observers(preview, images); 106 | } 107 | if (source) { 108 | this.register_source_observers(source, images); 109 | } 110 | if (reading) { 111 | this.register_reading_observers(reading, images); 112 | } 113 | } 114 | 115 | /** 116 | * Parses the root document into its view components. 117 | * 118 | * @param {Element} root - Root element of the document. 119 | * @returns {{preview: Element, source: Element, reading: Element}} 120 | * Root element of each view. 121 | */ 122 | parse_views( 123 | root: Element 124 | ): {preview: Element, source: Element, reading: Element} { 125 | const preview = root.querySelector('.markdown-source-view.is-live-preview'); 126 | const source = root.querySelector('.markdown-source-view:not(.is-live-preview'); 127 | const reading = root.querySelector('.markdown-reading-view'); 128 | 129 | return {preview, source, reading}; 130 | } 131 | 132 | /** 133 | * Register observers for the preview view. 134 | * 135 | * @param {Element} root - Root of the preview view. 136 | * @param {ParsedImages[]} images - Parsed images. 137 | */ 138 | register_preview_observers(root: Element, images: ParsedImage[]) { 139 | // clear previous captions 140 | const prev_caps = root.querySelectorAll( 141 | `.${ImageCaptionPlugin.caption_class}` 142 | ); 143 | prev_caps.forEach( cap => cap.remove() ); 144 | 145 | const markers = root.querySelectorAll('.image-caption-data'); 146 | markers.forEach( marker => { 147 | const img_index = parseInt(marker.getAttribute('data-image-caption-index')); 148 | const info = this.image_info[img_index]; 149 | const embed_type = info.embed_type; 150 | 151 | if (embed_type === EmbedType.Internal) { 152 | const img_wrap = closestSibling( 153 | marker, 154 | '.internal-embed.image-embed.is-loaded', 155 | -1 156 | ); 157 | 158 | if ( ! img_wrap ) { 159 | console.debug(`image container not found for mark ${img_index}`); 160 | return; 161 | } 162 | 163 | if ( info.caption ) { 164 | const cap = addCaption(img_wrap, info.caption); 165 | // const fig_num = img_index.toString() 166 | const fig_num = img_index + 1; 167 | cap.containerEl.setAttribute('data-image-caption-fignum', fig_num.toString()); 168 | } 169 | 170 | if ( info.size ) { 171 | setSize( img_wrap, info.size ); 172 | } 173 | } 174 | else if (embed_type === EmbedType.External) { 175 | 176 | } 177 | else { 178 | throw new Error(`Invalid embed type ${embed_type}.`); 179 | } 180 | } ); 181 | 182 | 183 | } 184 | 185 | /** 186 | * Register observers for the source view. 187 | * 188 | * @param {Element} root - Root of the source view. 189 | * @param {ParsedImages[]} images - Parsed images. 190 | */ 191 | register_source_observers(root: Element, images: ParsedImage[]) { 192 | 193 | } 194 | 195 | /** 196 | * Register observers for the reading view. 197 | * 198 | * @param {Element} root - Root of the reading view. 199 | * @param {ParsedImages[]} images - Parsed images. 200 | */ 201 | register_reading_observers(root: Element, images: ParsedImage[]) { 202 | 203 | } 204 | 205 | /** 206 | * Removes all observers. 207 | */ 208 | clear_observers() { 209 | 210 | } 211 | }; 212 | } 213 | 214 | 215 | export function viewObserver( 216 | plugin: ImageCaptionPlugin 217 | ): Extension { 218 | 219 | const view_plug = ViewPlugin.fromClass( 220 | ViewObserverFactory(plugin), 221 | { 222 | decorations: v => v.decorations 223 | } 224 | ); 225 | 226 | return [ 227 | view_plug 228 | ]; 229 | } 230 | -------------------------------------------------------------------------------- /styles.css: -------------------------------------------------------------------------------- 1 | /* Allow inline images to remain inline 2 | * while captions remain beneath. 3 | */ 4 | span.with_image_caption { 5 | display: inline-block; 6 | } 7 | 8 | /* Settings styling */ 9 | .setting-item-control.setting-error input { 10 | border-color: #990000; 11 | } 12 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": ".", 4 | "inlineSourceMap": true, 5 | "inlineSources": true, 6 | "module": "ESNext", 7 | "target": "ES6", 8 | "allowJs": true, 9 | "noImplicitAny": true, 10 | "moduleResolution": "node", 11 | "importHelpers": true, 12 | "lib": [ 13 | "dom", 14 | "es5", 15 | "scripthost", 16 | "es2015" 17 | ] 18 | }, 19 | "include": [ 20 | "**/*.ts" 21 | ] 22 | } 23 | -------------------------------------------------------------------------------- /versions.json: -------------------------------------------------------------------------------- 1 | { 2 | "0.0.15.alpha": "1.0.0", 3 | "0.0.14": "0.15.6", 4 | "0.0.13": "0.14.2", 5 | "0.0.12": "0.13.23", 6 | "0.0.11": "0.13.19", 7 | "0.0.10": "0.13.19", 8 | "0.0.9": "0.12.19", 9 | "0.0.8": "0.12.19", 10 | "0.0.7": "0.12.19", 11 | "0.0.6": "0.12.19", 12 | "0.0.5": "0.12.19", 13 | "0.0.4": "0.12.19", 14 | "0.0.3": "0.12.19", 15 | "0.0.2": "0.12.19", 16 | "0.0.1": "0.12.19" 17 | } --------------------------------------------------------------------------------