├── .gitignore ├── COPYING ├── ChangeLog ├── README ├── Rakefile ├── jekyll-rendering.gemspec └── lib └── jekyll ├── rendering.rb └── rendering └── version.rb /.gitignore: -------------------------------------------------------------------------------- 1 | doc 2 | doc.local 3 | pkg 4 | .gh-pages 5 | .jekyll 6 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | = License for jekyll-rendering 2 | 3 | GNU AFFERO GENERAL PUBLIC LICENSE 4 | Version 3, 19 November 2007 5 | 6 | Copyright (C) 2007 Free Software Foundation, Inc. 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | Preamble 11 | 12 | The GNU Affero General Public License is a free, copyleft license for 13 | software and other kinds of works, specifically designed to ensure 14 | cooperation with the community in the case of network server software. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | our General Public Licenses are intended to guarantee your freedom to 19 | share and change all versions of a program--to make sure it remains free 20 | software for all its users. 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 | Developers that use our General Public Licenses protect your rights 30 | with two steps: (1) assert copyright on the software, and (2) offer 31 | you this License which gives you legal permission to copy, distribute 32 | and/or modify the software. 33 | 34 | A secondary benefit of defending all users' freedom is that 35 | improvements made in alternate versions of the program, if they 36 | receive widespread use, become available for other developers to 37 | incorporate. Many developers of free software are heartened and 38 | encouraged by the resulting cooperation. However, in the case of 39 | software used on network servers, this result may fail to come about. 40 | The GNU General Public License permits making a modified version and 41 | letting the public access it on a server without ever releasing its 42 | source code to the public. 43 | 44 | The GNU Affero General Public License is designed specifically to 45 | ensure that, in such cases, the modified source code becomes available 46 | to the community. It requires the operator of a network server to 47 | provide the source code of the modified version running there to the 48 | users of that server. Therefore, public use of a modified version, on 49 | a publicly accessible server, gives the public access to the source 50 | code of the modified version. 51 | 52 | An older license, called the Affero General Public License and 53 | published by Affero, was designed to accomplish similar goals. This is 54 | a different license, not a version of the Affero GPL, but Affero has 55 | released a new version of the Affero GPL which permits relicensing under 56 | this license. 57 | 58 | The precise terms and conditions for copying, distribution and 59 | modification follow. 60 | 61 | TERMS AND CONDITIONS 62 | 63 | 0. Definitions. 64 | 65 | "This License" refers to version 3 of the GNU Affero General Public License. 66 | 67 | "Copyright" also means copyright-like laws that apply to other kinds of 68 | works, such as semiconductor masks. 69 | 70 | "The Program" refers to any copyrightable work licensed under this 71 | License. Each licensee is addressed as "you". "Licensees" and 72 | "recipients" may be individuals or organizations. 73 | 74 | To "modify" a work means to copy from or adapt all or part of the work 75 | in a fashion requiring copyright permission, other than the making of an 76 | exact copy. The resulting work is called a "modified version" of the 77 | earlier work or a work "based on" the earlier work. 78 | 79 | A "covered work" means either the unmodified Program or a work based 80 | on the Program. 81 | 82 | To "propagate" a work means to do anything with it that, without 83 | permission, would make you directly or secondarily liable for 84 | infringement under applicable copyright law, except executing it on a 85 | computer or modifying a private copy. Propagation includes copying, 86 | distribution (with or without modification), making available to the 87 | public, and in some countries other activities as well. 88 | 89 | To "convey" a work means any kind of propagation that enables other 90 | parties to make or receive copies. Mere interaction with a user through 91 | a computer network, with no transfer of a copy, is not conveying. 92 | 93 | An interactive user interface displays "Appropriate Legal Notices" 94 | to the extent that it includes a convenient and prominently visible 95 | feature that (1) displays an appropriate copyright notice, and (2) 96 | tells the user that there is no warranty for the work (except to the 97 | extent that warranties are provided), that licensees may convey the 98 | work under this License, and how to view a copy of this License. If 99 | the interface presents a list of user commands or options, such as a 100 | menu, a prominent item in the list meets this criterion. 101 | 102 | 1. Source Code. 103 | 104 | The "source code" for a work means the preferred form of the work 105 | for making modifications to it. "Object code" means any non-source 106 | form of a work. 107 | 108 | A "Standard Interface" means an interface that either is an official 109 | standard defined by a recognized standards body, or, in the case of 110 | interfaces specified for a particular programming language, one that 111 | is widely used among developers working in that language. 112 | 113 | The "System Libraries" of an executable work include anything, other 114 | than the work as a whole, that (a) is included in the normal form of 115 | packaging a Major Component, but which is not part of that Major 116 | Component, and (b) serves only to enable use of the work with that 117 | Major Component, or to implement a Standard Interface for which an 118 | implementation is available to the public in source code form. A 119 | "Major Component", in this context, means a major essential component 120 | (kernel, window system, and so on) of the specific operating system 121 | (if any) on which the executable work runs, or a compiler used to 122 | produce the work, or an object code interpreter used to run it. 123 | 124 | The "Corresponding Source" for a work in object code form means all 125 | the source code needed to generate, install, and (for an executable 126 | work) run the object code and to modify the work, including scripts to 127 | control those activities. However, it does not include the work's 128 | System Libraries, or general-purpose tools or generally available free 129 | programs which are used unmodified in performing those activities but 130 | which are not part of the work. For example, Corresponding Source 131 | includes interface definition files associated with source files for 132 | the work, and the source code for shared libraries and dynamically 133 | linked subprograms that the work is specifically designed to require, 134 | such as by intimate data communication or control flow between those 135 | subprograms and other parts of the work. 136 | 137 | The Corresponding Source need not include anything that users 138 | can regenerate automatically from other parts of the Corresponding 139 | Source. 140 | 141 | The Corresponding Source for a work in source code form is that 142 | same work. 143 | 144 | 2. Basic Permissions. 145 | 146 | All rights granted under this License are granted for the term of 147 | copyright on the Program, and are irrevocable provided the stated 148 | conditions are met. This License explicitly affirms your unlimited 149 | permission to run the unmodified Program. The output from running a 150 | covered work is covered by this License only if the output, given its 151 | content, constitutes a covered work. This License acknowledges your 152 | rights of fair use or other equivalent, as provided by copyright law. 153 | 154 | You may make, run and propagate covered works that you do not 155 | convey, without conditions so long as your license otherwise remains 156 | in force. You may convey covered works to others for the sole purpose 157 | of having them make modifications exclusively for you, or provide you 158 | with facilities for running those works, provided that you comply with 159 | the terms of this License in conveying all material for which you do 160 | not control copyright. Those thus making or running the covered works 161 | for you must do so exclusively on your behalf, under your direction 162 | and control, on terms that prohibit them from making any copies of 163 | your copyrighted material outside their relationship with you. 164 | 165 | Conveying under any other circumstances is permitted solely under 166 | the conditions stated below. Sublicensing is not allowed; section 10 167 | makes it unnecessary. 168 | 169 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 170 | 171 | No covered work shall be deemed part of an effective technological 172 | measure under any applicable law fulfilling obligations under article 173 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 174 | similar laws prohibiting or restricting circumvention of such 175 | measures. 176 | 177 | When you convey a covered work, you waive any legal power to forbid 178 | circumvention of technological measures to the extent such circumvention 179 | is effected by exercising rights under this License with respect to 180 | the covered work, and you disclaim any intention to limit operation or 181 | modification of the work as a means of enforcing, against the work's 182 | users, your or third parties' legal rights to forbid circumvention of 183 | technological measures. 184 | 185 | 4. Conveying Verbatim Copies. 186 | 187 | You may convey verbatim copies of the Program's source code as you 188 | receive it, in any medium, provided that you conspicuously and 189 | appropriately publish on each copy an appropriate copyright notice; 190 | keep intact all notices stating that this License and any 191 | non-permissive terms added in accord with section 7 apply to the code; 192 | keep intact all notices of the absence of any warranty; and give all 193 | recipients a copy of this License along with the Program. 194 | 195 | You may charge any price or no price for each copy that you convey, 196 | and you may offer support or warranty protection for a fee. 197 | 198 | 5. Conveying Modified Source Versions. 199 | 200 | You may convey a work based on the Program, or the modifications to 201 | produce it from the Program, in the form of source code under the 202 | terms of section 4, provided that you also meet all of these conditions: 203 | 204 | a) The work must carry prominent notices stating that you modified 205 | it, and giving a relevant date. 206 | 207 | b) The work must carry prominent notices stating that it is 208 | released under this License and any conditions added under section 209 | 7. This requirement modifies the requirement in section 4 to 210 | "keep intact all notices". 211 | 212 | c) You must license the entire work, as a whole, under this 213 | License to anyone who comes into possession of a copy. This 214 | License will therefore apply, along with any applicable section 7 215 | additional terms, to the whole of the work, and all its parts, 216 | regardless of how they are packaged. This License gives no 217 | permission to license the work in any other way, but it does not 218 | invalidate such permission if you have separately received it. 219 | 220 | d) If the work has interactive user interfaces, each must display 221 | Appropriate Legal Notices; however, if the Program has interactive 222 | interfaces that do not display Appropriate Legal Notices, your 223 | work need not make them do so. 224 | 225 | A compilation of a covered work with other separate and independent 226 | works, which are not by their nature extensions of the covered work, 227 | and which are not combined with it such as to form a larger program, 228 | in or on a volume of a storage or distribution medium, is called an 229 | "aggregate" if the compilation and its resulting copyright are not 230 | used to limit the access or legal rights of the compilation's users 231 | beyond what the individual works permit. Inclusion of a covered work 232 | in an aggregate does not cause this License to apply to the other 233 | parts of the aggregate. 234 | 235 | 6. Conveying Non-Source Forms. 236 | 237 | You may convey a covered work in object code form under the terms 238 | of sections 4 and 5, provided that you also convey the 239 | machine-readable Corresponding Source under the terms of this License, 240 | in one of these ways: 241 | 242 | a) Convey the object code in, or embodied in, a physical product 243 | (including a physical distribution medium), accompanied by the 244 | Corresponding Source fixed on a durable physical medium 245 | customarily used for software interchange. 246 | 247 | b) Convey the object code in, or embodied in, a physical product 248 | (including a physical distribution medium), accompanied by a 249 | written offer, valid for at least three years and valid for as 250 | long as you offer spare parts or customer support for that product 251 | model, to give anyone who possesses the object code either (1) a 252 | copy of the Corresponding Source for all the software in the 253 | product that is covered by this License, on a durable physical 254 | medium customarily used for software interchange, for a price no 255 | more than your reasonable cost of physically performing this 256 | conveying of source, or (2) access to copy the 257 | Corresponding Source from a network server at no charge. 258 | 259 | c) Convey individual copies of the object code with a copy of the 260 | written offer to provide the Corresponding Source. This 261 | alternative is allowed only occasionally and noncommercially, and 262 | only if you received the object code with such an offer, in accord 263 | with subsection 6b. 264 | 265 | d) Convey the object code by offering access from a designated 266 | place (gratis or for a charge), and offer equivalent access to the 267 | Corresponding Source in the same way through the same place at no 268 | further charge. You need not require recipients to copy the 269 | Corresponding Source along with the object code. If the place to 270 | copy the object code is a network server, the Corresponding Source 271 | may be on a different server (operated by you or a third party) 272 | that supports equivalent copying facilities, provided you maintain 273 | clear directions next to the object code saying where to find the 274 | Corresponding Source. Regardless of what server hosts the 275 | Corresponding Source, you remain obligated to ensure that it is 276 | available for as long as needed to satisfy these requirements. 277 | 278 | e) Convey the object code using peer-to-peer transmission, provided 279 | you inform other peers where the object code and Corresponding 280 | Source of the work are being offered to the general public at no 281 | charge under subsection 6d. 282 | 283 | A separable portion of the object code, whose source code is excluded 284 | from the Corresponding Source as a System Library, need not be 285 | included in conveying the object code work. 286 | 287 | A "User Product" is either (1) a "consumer product", which means any 288 | tangible personal property which is normally used for personal, family, 289 | or household purposes, or (2) anything designed or sold for incorporation 290 | into a dwelling. In determining whether a product is a consumer product, 291 | doubtful cases shall be resolved in favor of coverage. For a particular 292 | product received by a particular user, "normally used" refers to a 293 | typical or common use of that class of product, regardless of the status 294 | of the particular user or of the way in which the particular user 295 | actually uses, or expects or is expected to use, the product. A product 296 | is a consumer product regardless of whether the product has substantial 297 | commercial, industrial or non-consumer uses, unless such uses represent 298 | the only significant mode of use of the product. 299 | 300 | "Installation Information" for a User Product means any methods, 301 | procedures, authorization keys, or other information required to install 302 | and execute modified versions of a covered work in that User Product from 303 | a modified version of its Corresponding Source. The information must 304 | suffice to ensure that the continued functioning of the modified object 305 | code is in no case prevented or interfered with solely because 306 | modification has been made. 307 | 308 | If you convey an object code work under this section in, or with, or 309 | specifically for use in, a User Product, and the conveying occurs as 310 | part of a transaction in which the right of possession and use of the 311 | User Product is transferred to the recipient in perpetuity or for a 312 | fixed term (regardless of how the transaction is characterized), the 313 | Corresponding Source conveyed under this section must be accompanied 314 | by the Installation Information. But this requirement does not apply 315 | if neither you nor any third party retains the ability to install 316 | modified object code on the User Product (for example, the work has 317 | been installed in ROM). 318 | 319 | The requirement to provide Installation Information does not include a 320 | requirement to continue to provide support service, warranty, or updates 321 | for a work that has been modified or installed by the recipient, or for 322 | the User Product in which it has been modified or installed. Access to a 323 | network may be denied when the modification itself materially and 324 | adversely affects the operation of the network or violates the rules and 325 | protocols for communication across the network. 326 | 327 | Corresponding Source conveyed, and Installation Information provided, 328 | in accord with this section must be in a format that is publicly 329 | documented (and with an implementation available to the public in 330 | source code form), and must require no special password or key for 331 | unpacking, reading or copying. 332 | 333 | 7. Additional Terms. 334 | 335 | "Additional permissions" are terms that supplement the terms of this 336 | License by making exceptions from one or more of its conditions. 337 | Additional permissions that are applicable to the entire Program shall 338 | be treated as though they were included in this License, to the extent 339 | that they are valid under applicable law. If additional permissions 340 | apply only to part of the Program, that part may be used separately 341 | under those permissions, but the entire Program remains governed by 342 | this License without regard to the additional permissions. 343 | 344 | When you convey a copy of a covered work, you may at your option 345 | remove any additional permissions from that copy, or from any part of 346 | it. (Additional permissions may be written to require their own 347 | removal in certain cases when you modify the work.) You may place 348 | additional permissions on material, added by you to a covered work, 349 | for which you have or can give appropriate copyright permission. 350 | 351 | Notwithstanding any other provision of this License, for material you 352 | add to a covered work, you may (if authorized by the copyright holders of 353 | that material) supplement the terms of this License with terms: 354 | 355 | a) Disclaiming warranty or limiting liability differently from the 356 | terms of sections 15 and 16 of this License; or 357 | 358 | b) Requiring preservation of specified reasonable legal notices or 359 | author attributions in that material or in the Appropriate Legal 360 | Notices displayed by works containing it; or 361 | 362 | c) Prohibiting misrepresentation of the origin of that material, or 363 | requiring that modified versions of such material be marked in 364 | reasonable ways as different from the original version; or 365 | 366 | d) Limiting the use for publicity purposes of names of licensors or 367 | authors of the material; or 368 | 369 | e) Declining to grant rights under trademark law for use of some 370 | trade names, trademarks, or service marks; or 371 | 372 | f) Requiring indemnification of licensors and authors of that 373 | material by anyone who conveys the material (or modified versions of 374 | it) with contractual assumptions of liability to the recipient, for 375 | any liability that these contractual assumptions directly impose on 376 | those licensors and authors. 377 | 378 | All other non-permissive additional terms are considered "further 379 | restrictions" within the meaning of section 10. If the Program as you 380 | received it, or any part of it, contains a notice stating that it is 381 | governed by this License along with a term that is a further 382 | restriction, you may remove that term. If a license document contains 383 | a further restriction but permits relicensing or conveying under this 384 | License, you may add to a covered work material governed by the terms 385 | of that license document, provided that the further restriction does 386 | not survive such relicensing or conveying. 387 | 388 | If you add terms to a covered work in accord with this section, you 389 | must place, in the relevant source files, a statement of the 390 | additional terms that apply to those files, or a notice indicating 391 | where to find the applicable terms. 392 | 393 | Additional terms, permissive or non-permissive, may be stated in the 394 | form of a separately written license, or stated as exceptions; 395 | the above requirements apply either way. 396 | 397 | 8. Termination. 398 | 399 | You may not propagate or modify a covered work except as expressly 400 | provided under this License. Any attempt otherwise to propagate or 401 | modify it is void, and will automatically terminate your rights under 402 | this License (including any patent licenses granted under the third 403 | paragraph of section 11). 404 | 405 | However, if you cease all violation of this License, then your 406 | license from a particular copyright holder is reinstated (a) 407 | provisionally, unless and until the copyright holder explicitly and 408 | finally terminates your license, and (b) permanently, if the copyright 409 | holder fails to notify you of the violation by some reasonable means 410 | prior to 60 days after the cessation. 411 | 412 | Moreover, your license from a particular copyright holder is 413 | reinstated permanently if the copyright holder notifies you of the 414 | violation by some reasonable means, this is the first time you have 415 | received notice of violation of this License (for any work) from that 416 | copyright holder, and you cure the violation prior to 30 days after 417 | your receipt of the notice. 418 | 419 | Termination of your rights under this section does not terminate the 420 | licenses of parties who have received copies or rights from you under 421 | this License. If your rights have been terminated and not permanently 422 | reinstated, you do not qualify to receive new licenses for the same 423 | material under section 10. 424 | 425 | 9. Acceptance Not Required for Having Copies. 426 | 427 | You are not required to accept this License in order to receive or 428 | run a copy of the Program. Ancillary propagation of a covered work 429 | occurring solely as a consequence of using peer-to-peer transmission 430 | to receive a copy likewise does not require acceptance. However, 431 | nothing other than this License grants you permission to propagate or 432 | modify any covered work. These actions infringe copyright if you do 433 | not accept this License. Therefore, by modifying or propagating a 434 | covered work, you indicate your acceptance of this License to do so. 435 | 436 | 10. Automatic Licensing of Downstream Recipients. 437 | 438 | Each time you convey a covered work, the recipient automatically 439 | receives a license from the original licensors, to run, modify and 440 | propagate that work, subject to this License. You are not responsible 441 | for enforcing compliance by third parties with this License. 442 | 443 | An "entity transaction" is a transaction transferring control of an 444 | organization, or substantially all assets of one, or subdividing an 445 | organization, or merging organizations. If propagation of a covered 446 | work results from an entity transaction, each party to that 447 | transaction who receives a copy of the work also receives whatever 448 | licenses to the work the party's predecessor in interest had or could 449 | give under the previous paragraph, plus a right to possession of the 450 | Corresponding Source of the work from the predecessor in interest, if 451 | the predecessor has it or can get it with reasonable efforts. 452 | 453 | You may not impose any further restrictions on the exercise of the 454 | rights granted or affirmed under this License. For example, you may 455 | not impose a license fee, royalty, or other charge for exercise of 456 | rights granted under this License, and you may not initiate litigation 457 | (including a cross-claim or counterclaim in a lawsuit) alleging that 458 | any patent claim is infringed by making, using, selling, offering for 459 | sale, or importing the Program or any portion of it. 460 | 461 | 11. Patents. 462 | 463 | A "contributor" is a copyright holder who authorizes use under this 464 | License of the Program or a work on which the Program is based. The 465 | work thus licensed is called the contributor's "contributor version". 466 | 467 | A contributor's "essential patent claims" are all patent claims 468 | owned or controlled by the contributor, whether already acquired or 469 | hereafter acquired, that would be infringed by some manner, permitted 470 | by this License, of making, using, or selling its contributor version, 471 | but do not include claims that would be infringed only as a 472 | consequence of further modification of the contributor version. For 473 | purposes of this definition, "control" includes the right to grant 474 | patent sublicenses in a manner consistent with the requirements of 475 | this License. 476 | 477 | Each contributor grants you a non-exclusive, worldwide, royalty-free 478 | patent license under the contributor's essential patent claims, to 479 | make, use, sell, offer for sale, import and otherwise run, modify and 480 | propagate the contents of its contributor version. 481 | 482 | In the following three paragraphs, a "patent license" is any express 483 | agreement or commitment, however denominated, not to enforce a patent 484 | (such as an express permission to practice a patent or covenant not to 485 | sue for patent infringement). To "grant" such a patent license to a 486 | party means to make such an agreement or commitment not to enforce a 487 | patent against the party. 488 | 489 | If you convey a covered work, knowingly relying on a patent license, 490 | and the Corresponding Source of the work is not available for anyone 491 | to copy, free of charge and under the terms of this License, through a 492 | publicly available network server or other readily accessible means, 493 | then you must either (1) cause the Corresponding Source to be so 494 | available, or (2) arrange to deprive yourself of the benefit of the 495 | patent license for this particular work, or (3) arrange, in a manner 496 | consistent with the requirements of this License, to extend the patent 497 | license to downstream recipients. "Knowingly relying" means you have 498 | actual knowledge that, but for the patent license, your conveying the 499 | covered work in a country, or your recipient's use of the covered work 500 | in a country, would infringe one or more identifiable patents in that 501 | country that you have reason to believe are valid. 502 | 503 | If, pursuant to or in connection with a single transaction or 504 | arrangement, you convey, or propagate by procuring conveyance of, a 505 | covered work, and grant a patent license to some of the parties 506 | receiving the covered work authorizing them to use, propagate, modify 507 | or convey a specific copy of the covered work, then the patent license 508 | you grant is automatically extended to all recipients of the covered 509 | work and works based on it. 510 | 511 | A patent license is "discriminatory" if it does not include within 512 | the scope of its coverage, prohibits the exercise of, or is 513 | conditioned on the non-exercise of one or more of the rights that are 514 | specifically granted under this License. You may not convey a covered 515 | work if you are a party to an arrangement with a third party that is 516 | in the business of distributing software, under which you make payment 517 | to the third party based on the extent of your activity of conveying 518 | the work, and under which the third party grants, to any of the 519 | parties who would receive the covered work from you, a discriminatory 520 | patent license (a) in connection with copies of the covered work 521 | conveyed by you (or copies made from those copies), or (b) primarily 522 | for and in connection with specific products or compilations that 523 | contain the covered work, unless you entered into that arrangement, 524 | or that patent license was granted, prior to 28 March 2007. 525 | 526 | Nothing in this License shall be construed as excluding or limiting 527 | any implied license or other defenses to infringement that may 528 | otherwise be available to you under applicable patent law. 529 | 530 | 12. No Surrender of Others' Freedom. 531 | 532 | If conditions are imposed on you (whether by court order, agreement or 533 | otherwise) that contradict the conditions of this License, they do not 534 | excuse you from the conditions of this License. If you cannot convey a 535 | covered work so as to satisfy simultaneously your obligations under this 536 | License and any other pertinent obligations, then as a consequence you may 537 | not convey it at all. For example, if you agree to terms that obligate you 538 | to collect a royalty for further conveying from those to whom you convey 539 | the Program, the only way you could satisfy both those terms and this 540 | License would be to refrain entirely from conveying the Program. 541 | 542 | 13. Remote Network Interaction; Use with the GNU General Public License. 543 | 544 | Notwithstanding any other provision of this License, if you modify the 545 | Program, your modified version must prominently offer all users 546 | interacting with it remotely through a computer network (if your version 547 | supports such interaction) an opportunity to receive the Corresponding 548 | Source of your version by providing access to the Corresponding Source 549 | from a network server at no charge, through some standard or customary 550 | means of facilitating copying of software. This Corresponding Source 551 | shall include the Corresponding Source for any work covered by version 3 552 | of the GNU General Public License that is incorporated pursuant to the 553 | following paragraph. 554 | 555 | Notwithstanding any other provision of this License, you have 556 | permission to link or combine any covered work with a work licensed 557 | under version 3 of the GNU General Public License into a single 558 | combined work, and to convey the resulting work. The terms of this 559 | License will continue to apply to the part which is the covered work, 560 | but the work with which it is combined will remain governed by version 561 | 3 of the GNU General Public License. 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 Affero General Public License from time to time. Such new versions 567 | will 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. 646 | 647 | You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer 653 | network, you should also make sure that it provides a way for users to 654 | get its source. For example, if your program is a web application, its 655 | interface could display a "Source" link that leads users to an archive 656 | of the code. There are many ways you could offer source, and different 657 | solutions will be better for different programs; see section 13 for the 658 | specific requirements. 659 | 660 | You should also get your employer (if you work as a programmer) or school, 661 | if any, to sign a "copyright disclaimer" for the program, if necessary. 662 | For more information on this, and how to apply and follow the GNU AGPL, see 663 | . 664 | -------------------------------------------------------------------------------- /ChangeLog: -------------------------------------------------------------------------------- 1 | # markup: rd 2 | 3 | = Revision history for jekyll-rendering 4 | 5 | == 0.0.9 [2012-05-24] 6 | 7 | * Include backtrace in render_error. 8 | * Use "lazy" OpenStruct for Erb. 9 | 10 | == 0.0.8 [2012-05-22] 11 | 12 | * Added support for Erubis. (Used by default if available.) 13 | * Work around encoding issues on Ruby 1.9. 14 | 15 | == 0.0.7 [2011-03-31] 16 | 17 | * Include ERB::Util in Jekyll::Rendering::Erb::Helpers. 18 | 19 | == 0.0.6 [2011-03-09] 20 | 21 | * Defined Jekyll::Rendering::ERB_OPTIONS to allow 22 | adjusting behaviour of ERB.new. 23 | 24 | == 0.0.5 [2010-10-29] 25 | 26 | * Refactored include_file. 27 | * Accept hash of local assigns instead of binding. 28 | * Denote inclusion from current directory by './'. 29 | 30 | == 0.0.4 [2010-10-01] 31 | 32 | * Allow inclusion of files from *current* directory. 33 | 34 | == 0.0.3 [2010-09-29] 35 | 36 | * Fixed nested layouts. 37 | 38 | == 0.0.2 [2010-07-01] 39 | 40 | * Refactoring and documentation. 41 | * Introduced Jekyll::Engine::Erb::Helpers module 42 | * Provide aliases to original methods 43 | * Credits. 44 | 45 | == 0.0.1 [2010-06-30] 46 | 47 | * Birthday :-) 48 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | = jekyll-rendering - Jekyll plugin to provide alternative rendering engines. 2 | 3 | == VERSION 4 | 5 | This documentation refers to jekyll-rendering version 0.0.9 6 | 7 | 8 | == DESCRIPTION 9 | 10 | Jekyll plugin to provide alternative rendering engines. 11 | 12 | Add the following to your _plugins/ext.rb file: 13 | 14 | require 'jekyll/rendering' 15 | 16 | Then set +engine+ in your _config.yml. The default engine is +liquid+. 17 | 18 | Options passed to ERB.new are taken from Jekyll::Rendering::ERB_OPTIONS. 19 | Modify this array if you want to change defaults. 20 | 21 | 22 | == TODO 23 | 24 | * Automatic engine detection by file extension? (..) 25 | 26 | 27 | == LINKS 28 | 29 | 30 | Documentation:: http://rdoc.info/gems/jekyll-rendering 31 | Source code:: http://github.com/prometheus-ev/jekyll-rendering 32 | RubyGem:: http://rubygems.org/gems/jekyll-rendering 33 | 34 | 35 | == AUTHORS 36 | 37 | * Jens Wille 38 | 39 | 40 | == CREDITS 41 | 42 | * Arne Eilermann for the original idea 43 | and implementation. 44 | 45 | 46 | == LICENSE AND COPYRIGHT 47 | 48 | Copyright (C) 2010-2012 University of Cologne, 49 | Albertus-Magnus-Platz, 50923 Cologne, Germany 50 | 51 | Copyright (C) 2013 Jens Wille 52 | 53 | jekyll-rendering is free software: you can redistribute it and/or modify it 54 | under the terms of the GNU Affero General Public License as published by the 55 | Free Software Foundation, either version 3 of the License, or (at your option) 56 | any later version. 57 | 58 | jekyll-rendering is distributed in the hope that it will be useful, but WITHOUT 59 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 60 | FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more 61 | details. 62 | 63 | You should have received a copy of the GNU Affero General Public License along 64 | with jekyll-rendering. If not, see . 65 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require File.expand_path(%q{../lib/jekyll/rendering/version}, __FILE__) 2 | 3 | begin 4 | require 'hen' 5 | 6 | Hen.lay! {{ 7 | :gem => { 8 | :name => %q{jekyll-rendering}, 9 | :version => Jekyll::Rendering::VERSION, 10 | :summary => %q{Jekyll plugin to provide alternative rendering engines.}, 11 | :author => %q{Jens Wille}, 12 | :email => %q{jens.wille@gmail.com}, 13 | :license => %q{AGPL}, 14 | :homepage => :"prometheus-ev", 15 | :dependencies => %w[] 16 | } 17 | }} 18 | rescue LoadError => err 19 | warn "Please install the `hen' gem. (#{err})" 20 | end 21 | 22 | begin 23 | require 'jekyll/testtasks/rake' 24 | rescue LoadError => err 25 | warn "Please install the `jekyll-testtasks' gem. (#{err})" 26 | end 27 | -------------------------------------------------------------------------------- /jekyll-rendering.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | 3 | Gem::Specification.new do |s| 4 | s.name = "jekyll-rendering" 5 | s.version = "0.0.9" 6 | 7 | s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= 8 | s.authors = ["Jens Wille"] 9 | s.date = "2013-07-15" 10 | s.description = "Jekyll plugin to provide alternative rendering engines." 11 | s.email = "jens.wille@gmail.com" 12 | s.extra_rdoc_files = ["README", "COPYING", "ChangeLog"] 13 | s.files = ["lib/jekyll/rendering.rb", "lib/jekyll/rendering/version.rb", "COPYING", "ChangeLog", "README", "Rakefile"] 14 | s.homepage = "http://github.com/prometheus-ev/jekyll-rendering" 15 | s.licenses = ["AGPL"] 16 | s.rdoc_options = ["--charset", "UTF-8", "--line-numbers", "--all", "--title", "jekyll-rendering Application documentation (v0.0.9)", "--main", "README"] 17 | s.require_paths = ["lib"] 18 | s.rubygems_version = "2.0.5" 19 | s.summary = "Jekyll plugin to provide alternative rendering engines." 20 | end 21 | -------------------------------------------------------------------------------- /lib/jekyll/rendering.rb: -------------------------------------------------------------------------------- 1 | #-- 2 | ############################################################################### 3 | # # 4 | # jekyll-rendering -- Jekyll plugin to provide alternative rendering engines # 5 | # # 6 | # Copyright (C) 2010-2012 University of Cologne, # 7 | # Albertus-Magnus-Platz, # 8 | # 50923 Cologne, Germany # 9 | # # 10 | # Copyright (C) 2013 Jens Wille # 11 | # # 12 | # Authors: # 13 | # Jens Wille # 14 | # # 15 | # jekyll-rendering is free software; you can redistribute it and/or modify it # 16 | # under the terms of the GNU Affero General Public License as published by # 17 | # the Free Software Foundation; either version 3 of the License, or (at your # 18 | # option) any later version. # 19 | # # 20 | # jekyll-rendering is distributed in the hope that it will be useful, but # 21 | # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY # 22 | # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public # 23 | # License for more details. # 24 | # # 25 | # You should have received a copy of the GNU Affero General Public License # 26 | # along with jekyll-rendering. If not, see . # 27 | # # 28 | ############################################################################### 29 | #++ 30 | 31 | require 'erb' 32 | require 'ostruct' 33 | 34 | begin 35 | require 'erubis' 36 | rescue LoadError 37 | end 38 | 39 | module Jekyll 40 | 41 | module Rendering 42 | 43 | # Options passed to ERB.new: +safe_level+, +trim_mode+, +eoutvar+. 44 | ERB_OPTIONS = [nil, nil, '_erbout' ] 45 | 46 | ERROR_TRACE = 3 47 | 48 | end 49 | 50 | module Convertible 51 | 52 | alias_method :_rendering_original_do_layout, :do_layout 53 | 54 | # Overwrites the original method to use the configured rendering engine. 55 | def do_layout(payload, layouts) 56 | info = { :filters => [Jekyll::Filters], :registers => { :site => site } } 57 | 58 | payload['pygments_prefix'] = converter.pygments_prefix 59 | payload['pygments_suffix'] = converter.pygments_suffix 60 | 61 | # render and transform content (this becomes the final content of the object) 62 | self.content = engine.render(payload, content, info, data) 63 | transform 64 | 65 | # output keeps track of what will finally be written 66 | self.output = content 67 | 68 | # recursively render layouts 69 | layout = self 70 | 71 | while layout = layouts[layout.data['layout']] 72 | payload = payload.deep_merge('content' => output, 'page' => layout.data) 73 | self.output = engine.render(payload, output, info, data, layout.content) 74 | end 75 | end 76 | 77 | # call-seq: 78 | # engine => aClass 79 | # 80 | # Returns the Engine class according to the configuration setting for 81 | # +engine+ (see subclasses of Engine::Base). Defaults to Engine::Liquid. 82 | def engine 83 | @engine ||= Engine[site.config['engine'] ||= 'liquid'] 84 | end 85 | 86 | end 87 | 88 | module Engine 89 | 90 | # call-seq: 91 | # Engine[engine] => aClass 92 | # 93 | # Returns the subclass whose name corresponds to +engine+. 94 | def self.[](engine) 95 | const_get(engine.capitalize) 96 | end 97 | 98 | class Base 99 | 100 | # call-seq: 101 | # Engine::Base.render(*args) 102 | # 103 | # Renders the output. Defers to engine's render method. 104 | def self.render(payload, content, info, data = {}, layout = nil) 105 | new(payload, content, info, data).render(layout || content) 106 | end 107 | 108 | attr_reader :payload, :info, :data 109 | attr_accessor :content 110 | 111 | def initialize(payload, content = nil, info = {}, data = {}) 112 | @payload, @content, @info, @data = payload, content, info, data 113 | end 114 | 115 | # call-seq: 116 | # render 117 | # 118 | # Renders the output. Must be implemented by subclass. 119 | def render 120 | raise NotImplementedError 121 | end 122 | 123 | def render_error(err, renderer = nil, trace = Rendering::ERROR_TRACE) 124 | msg = [self.class.name.split('::').last] 125 | msg << "[#{renderer}]" if renderer 126 | 127 | msg << 'Exception:' << err 128 | msg << "(in #{data['layout'] || '(top)'})" 129 | 130 | msg << "(from #{err.backtrace[0, trace].join(', ')})" if trace > 0 131 | 132 | msg.join(' ') 133 | end 134 | 135 | end 136 | 137 | class Liquid < Base 138 | 139 | # call-seq: 140 | # engine.render 141 | # engine.render(content) 142 | # 143 | # Renders the +content+ using ::Liquid::Template::parse and then 144 | # calling ::Liquid::Template#render with +payload+ and +info+. 145 | def render(content = content) 146 | ::Liquid::Template.parse(content).render(payload, info) 147 | rescue => err 148 | render_error(err) 149 | end 150 | 151 | end 152 | 153 | class Erb < Base 154 | 155 | class LazyStruct < OpenStruct 156 | 157 | def initialize(hash) 158 | @table = Hash.new { |h, k| 159 | new_ostruct_member(k) 160 | h[k] = h.has_key?(s = k.to_s) ? h[s] : nil 161 | }.update(hash) 162 | end 163 | 164 | end 165 | 166 | class << self; attr_accessor :renderer; end 167 | 168 | attr_reader :site, :page, :renderer, :encoding 169 | 170 | def initialize(*args) 171 | super 172 | 173 | if ''.respond_to?(:force_encoding) 174 | @encoding = site.respond_to?(:encoding) && 175 | site.encoding || Encoding.default_external 176 | 177 | data.each_value { |val| 178 | if val.respond_to?(:force_encoding) && !val.frozen? 179 | val.force_encoding(encoding) 180 | end 181 | } 182 | end 183 | 184 | [Helpers, *info[:filters]].each { |mod| extend mod } 185 | 186 | %w[site page paginator].each { |key| 187 | value = payload[key] or next 188 | instance_variable_set("@#{key}", LazyStruct.new(value)) 189 | } 190 | 191 | @renderer = self.class.renderer || 192 | (Object.const_defined?(:Erubis) ? Erubis::FastEruby : ERB) 193 | end 194 | 195 | # call-seq: 196 | # engine.render => aString 197 | # engine.render(content) => aString 198 | # engine.render(content, local_assigns) => aString 199 | # 200 | # Renders the +content+ as ERB template. Assigns optional 201 | # +local_assigns+ for use in template if provided. 202 | def render(content = content, local_assigns = {}, *args) 203 | assigns = '<% ' << local_assigns.keys.map { |var| 204 | "#{var} = local_assigns[#{var.inspect}]" 205 | }.join("\n") << " %>\n" unless local_assigns.empty? 206 | 207 | args.insert(0, "#{assigns}#{content}", binding) 208 | renderer == ERB ? _render_erb(*args) : _render(*args) 209 | rescue => err 210 | render_error(err, renderer) 211 | end 212 | 213 | def _render_erb(doc, binding, args = Rendering::ERB_OPTIONS) 214 | res = renderer.new(doc, *args).result(binding) 215 | encoding ? res.force_encoding(encoding) : res 216 | end 217 | 218 | def _render(doc, binding, args = []) 219 | renderer.new(doc, *args).result(binding) 220 | end 221 | 222 | module Helpers 223 | 224 | include ERB::Util 225 | 226 | # call-seq: 227 | # include_file file => aString 228 | # include_file file, local_assigns => aString 229 | # 230 | # Includes file +file+ from _includes directory, or current 231 | # directory if +file+ starts with ./, rendered as ERB template. 232 | # Passes optional +local_assigns+ on to #render. 233 | def include_file(file, local_assigns = {}) 234 | @templates ||= Hash.new { |h, k| 235 | h[k] = File.readable?(k) && File.read(k) 236 | } 237 | 238 | dir = file =~ /\A\.\// ? File.dirname(page.url) : '_includes' 239 | 240 | if template = @templates[File.join(site.source, dir, file)] 241 | render(template, local_assigns) 242 | else 243 | "[Included file `#{file}' not found in `#{dir}'.]" 244 | end 245 | end 246 | 247 | # call-seq: 248 | # highlight text => aString 249 | # highlight text, lang => aString 250 | # 251 | # Highlights +text+ according to +lang+ (defaults to Ruby). 252 | def highlight(text, lang = :ruby) 253 | if site.pygments 254 | render_pygments(text, lang) 255 | else 256 | render_codehighlighter(text, lang) 257 | end 258 | end 259 | 260 | protected 261 | 262 | def render_pygments(text, lang) 263 | output = add_code_tags(Albino.new(text, lang).to_s, lang) 264 | "#{payload['pygments_prefix']}#{output}#{payload['pygments_suffix']}" 265 | end 266 | 267 | def render_codehighlighter(text, lang) 268 | #The div is required because RDiscount blows ass 269 | <<-HTML 270 |
271 | 
272 |       #{h(text).strip}
273 |
274 |
275 | HTML 276 | end 277 | 278 | def add_code_tags(code, lang) 279 | # Add nested tags to code blocks 280 | code.sub(%r{
},  %Q{
}).
281 |                sub(%r{
}, %q{
}) 282 | end 283 | 284 | end 285 | 286 | end 287 | 288 | end 289 | 290 | # Provide an engine-agnostic name for the hash representation. 291 | [Post, Page, Pager].each { |klass| 292 | klass.send(:alias_method, :to_hash, :to_liquid) 293 | } 294 | 295 | end 296 | -------------------------------------------------------------------------------- /lib/jekyll/rendering/version.rb: -------------------------------------------------------------------------------- 1 | module Jekyll 2 | 3 | module Rendering 4 | 5 | module Version 6 | 7 | MAJOR = 0 8 | MINOR = 0 9 | TINY = 9 10 | 11 | class << self 12 | 13 | # Returns array representation. 14 | def to_a 15 | [MAJOR, MINOR, TINY] 16 | end 17 | 18 | # Short-cut for version string. 19 | def to_s 20 | to_a.join('.') 21 | end 22 | 23 | end 24 | 25 | end 26 | 27 | VERSION = Version.to_s 28 | 29 | end 30 | 31 | end 32 | --------------------------------------------------------------------------------