├── .docs.sh ├── .gitignore ├── .travis.yml ├── LICENSE ├── MANIFEST.in ├── Makefile ├── README.md ├── design.py ├── docs ├── assets │ └── images │ │ └── mkpdfs.png ├── getting-started.md ├── index.md ├── layout-design.md ├── release-notes.md └── stylesheets │ └── extra.css ├── mkdocs.yml ├── mkpdfs_mkdocs ├── __init__.py ├── design │ ├── FiraSans-Bold.otf │ ├── FiraSans-Italic.otf │ ├── FiraSans-Light.otf │ ├── FiraSans-LightItalic.otf │ ├── FiraSans-Regular.otf │ ├── cover.jpg │ ├── fonts │ │ ├── font-awesome.css │ │ ├── material-icons.css │ │ └── specimen │ │ │ ├── FontAwesome.ttf │ │ │ ├── FontAwesome.woff │ │ │ ├── FontAwesome.woff2 │ │ │ ├── MaterialIcons-Regular.ttf │ │ │ ├── MaterialIcons-Regular.woff │ │ │ └── MaterialIcons-Regular.woff2 │ ├── package-lock.json │ ├── package.json │ ├── report.scss │ └── stylesheets │ │ ├── _config.scss │ │ ├── _extensions.scss │ │ ├── base │ │ ├── .stylelintrc │ │ └── _icons.scss │ │ ├── extensions │ │ ├── _admonition.scss │ │ ├── _codehilite.scss │ │ ├── _footnotes.scss │ │ └── pymdown │ │ │ ├── _arithmatex.scss │ │ │ ├── _critic.scss │ │ │ ├── _details.scss │ │ │ ├── _emoji.scss │ │ │ ├── _inlinehilite.scss │ │ │ ├── _superfences.scss │ │ │ └── _tasklist.scss │ │ └── helpers │ │ ├── _break.scss │ │ └── _px2em.scss ├── generator.py ├── mkpdfs.py ├── preprocessor │ ├── __init__.py │ ├── links │ │ ├── __init__.py │ │ ├── transform.py │ │ └── util.py │ └── prep.py └── utils.py ├── setup.cfg └── setup.py /.docs.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Exit on fail 4 | if [ "$TRAVIS_BRANCH" == "master" -a "$TRAVIS_PULL_REQUEST" == "false" -a "$GEN_DOC" == "yes" ]; then 5 | REMOTE="https://${GH_TOKEN}@github.com/comwes/mkpdfs-mkdocs-plugin" 6 | 7 | # Set configuration for repository and deploy documentation 8 | git config --global user.name "${GH_NAME}" 9 | git config --global user.email "${GH_EMAIL}" 10 | git remote set-url origin ${REMOTE} 11 | sudo apt-get update 12 | sudo apt-get install -y build-essential libcairo2 libpango-1.0-0 libpangocairo-1.0-0 libgdk-pixbuf2.0-0 libffi-dev shared-mime-info 13 | 14 | # Build documentation with overrides and publish to GitHub pages 15 | mkdocs gh-deploy --force 16 | fi 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .installed.cfg 2 | bin 3 | develop-eggs 4 | dist 5 | downloads 6 | eggs 7 | parts 8 | *.egg-info 9 | *.pyc 10 | lib 11 | lib64 12 | __pycache__ 13 | node_modules 14 | .idea/* 15 | .DS_Store 16 | mkpdfs/design/report.css 17 | mkpdfs/design/stylesheets/extensions.css 18 | site 19 | report.css 20 | build 21 | venv 22 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | sudo: false 3 | matrix: 4 | include: 5 | - name: Python 3.8 6 | dist: bionic 7 | python: 3.8 8 | node_js: 14 9 | env: GEN_DOC=yes 10 | 11 | before_install: 12 | - pip3 install mkdocs-material 13 | - pip3 install --upgrade pip 14 | - pip3 install npm 15 | - pip3 install twine 16 | - pip3 install mkdocs-material 17 | addons: 18 | apt: 19 | sources: 20 | - sourceline: 'deb http://be.archive.ubuntu.com/ubuntu/ bionic main restricted' 21 | update: true 22 | 23 | cache: 24 | pip: true 25 | 26 | git: 27 | depth: 3 28 | quiet: true 29 | 30 | script: 31 | - make dist 32 | 33 | after_success: 34 | - ./.docs.sh 35 | 36 | notifications: 37 | email: 38 | on_success: never 39 | 40 | deploy: 41 | - provider: pypi 42 | user: comwes 43 | password: $PYPIPROD 44 | skip_existing: true 45 | skip_cleanup: true 46 | on: 47 | tags: true 48 | branch: master 49 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | recursive-include mkpdfs_mkdocs *.jpg *.otf *.css *.ttf *.woff *.woff2 2 | recursive-exclude mkpdfs_mkdocs/design/node_* * 3 | recursive-exclude * *.scss *.json 4 | recursive-exclude * __pycache__ 5 | recursive-exclude * *.py[co] 6 | recursive-exclude * .gitignore 7 | include README.md 8 | include LICENSE 9 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PROJECT_NAME := $(shell python3 setup.py --name) 2 | PROJECT_VERSION := $(shell python3 setup.py --version) 3 | 4 | SHELL := /bin/bash 5 | BOLD := \033[1m 6 | DIM := \033[2m 7 | RESET := \033[0m 8 | 9 | bold=$(tput bold) 10 | reset=$(tput sgr0) 11 | green := $(tput setaf 2) 12 | 13 | .PHONY: dist 14 | dist: clean build install 15 | 16 | 17 | .PHONY: build 18 | build: 19 | @tput bold && tput setaf 2 20 | @echo "Building package $(PROJECT_NAME) $(PROJECT_VERSION)" 21 | @tput sgr0 22 | @pip3 install npm 23 | @python3 design.py 24 | @python3 setup.py sdist bdist_wheel 25 | 26 | .PHONY: install 27 | install: 28 | @pip3 install dist/$(PROJECT_NAME)-$(PROJECT_VERSION).tar.gz 29 | 30 | .PHONY: clean 31 | clean: 32 | @tput bold && tput setaf 2 33 | @echo "Cleaning up ... " 34 | @tput sgr0 35 | @rm -rf dist 36 | 37 | .PHONY: develop 38 | develop: 39 | @tput bold && tput setaf 2 40 | @echo "Installing package for development purpose $(PROJECT_NAME) $(PROJECT_VERSION)" 41 | @tput sgr0 42 | @pip3 install npm 43 | @python3 design.py 44 | @pip3 install -e . 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MkPDFs for MkDocs [![Build Status](https://travis-ci.com/comwes/mkpdfs-mkdocs-plugin.svg?branch=master)](https://travis-ci.com/comwes/mkpdfs-mkdocs-plugin) 2 | 3 | *It's a MkDocs plugin that export your documentation in a single PDF file* 4 | 5 | [![MkPDFs for MkDocs](https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/master/docs/assets/images/mkpdfs.png)][mkpdfsdoc] 6 | 7 | [mkpdfsdoc]: https://mkpdfs.comwes.eu 8 | 9 | 10 | The MkPDFs plugin will export yor documentation in your MkDocs repository as a PDF file using [WeasyPrint](http://weasyprint.org/). 11 | 12 | Unlike other plugin where customizing the design of the generated PDF is complicated, this plugin brings the ability to completely control the design of the generated PDF. 13 | 14 | What makes this plugin particular, is that: 15 | 16 | 1. Your documentation is exported as a single PDF file 17 | 1. The order of pages fits the navigation as defined in the MkDocs configuration file 18 | 1. The ability to override the default design to make it fit your needs 19 | 1. The ability to exclude some files from the generated PDF 20 | 1. No layout issues 21 | 1. No conflict with the theme design 22 | 1. Table of contents integrated in the PDF 23 | 24 | ## Requirements 25 | 26 | 1. This package requires MkDocs version 1.0 27 | 2. Python 3.4 or higher 28 | 3. WeasyPrint depends on cairo, Pango and GDK-PixBuf which need to be installed separately. Please follow your platform installation instructions carefully: 29 | - [Linux][weasyprint-linux] 30 | - [MacOS][weasyprint-macos] 31 | - [Windows][weasyprint-windows] 32 | 33 | ## Limitation 34 | 35 | The PDF version of the documentation will not be created if the used generated page content's is not enclosed in an `
` tag or in a `
` tag with property `role="main"`. 36 | 37 | ## Installation 38 | 39 | Install the package with `pip`: 40 | 41 | ```bash 42 | pip3 install mkpdfs-mkdocs 43 | ``` 44 | 45 | Enable the plugin in your `mkdocs.yml` as folowing 46 | 47 | ```yaml 48 | plugins: 49 | - search 50 | - mkpdfs 51 | ``` 52 | 53 | or with options 54 | 55 | ```yaml 56 | plugins: 57 | - search 58 | - mkpdfs: 59 | - company: The War Company Inc. 60 | - author: Monsieur Silvestre 61 | ``` 62 | 63 | > **Note:** If you enable this plugin and you don't have `plugins` entry in your MkDocs config file yet, you will need to explicitly enable the `search` plugin. This plugin is enabled by default when no `plugins` entry is set. 64 | 65 | You can find further information about plugins in the [MkDocs documentation][mkdocs-plugins]. 66 | 67 | ## How does it work? 68 | 69 | When building or serving your documentation with `mkdocs build` or `mkdocs serve`, the following message will be displayed if everything wend smoothly: 70 | 71 | > The PDF version of the documentation has been generated. 72 | 73 | ## Options 74 | 75 | This plugin supports following options to allow you better handle the customisation of the generated PDF. 76 | 77 | 78 | | Option | Description | 79 | | --- | --- | 80 | | `author` | The author of the document. This information will be printed on the cover page of the generated PDF. | 81 | | `company` | If this documentation is from a company, then you should provide this information. It will be displayed on the front page of the documentation, bellow the author information| 82 | | `toc_title` | The table of content title. The default value is **Table of Contents** | 83 | | `toc_position` | The position of the table of contents. This option supports 3 differents values: `pre` to put the toc at the beginning of the file but after the cover (**the default value**), `post` to put it at the end of the file or `none` to not generate it at all. | 84 | | `output_path` | The file name of the generated PDF, relative to the `site_dir`. By default this location is set to `pdf/combined.pdf`| 85 | | `pdf_links` | Create link to download the generated PDF to the top of each HTML page. By default this is enabled | 86 | | `design` | Relative to your `MkDocs repository`, this option is the location of the CSS file defining the layout of the generated PDF. If this option is not defined the default design will be used. Defining an non existing file will cause the build or serve failure. | 87 | 88 | ## Contributing 89 | 90 | From reporting a bug to submitting a pull request, every contribution is appreciated and welcome. Report bugs, ask questions and request features using [Github issues][github-issues]. 91 | 92 | 93 | ## Thanks to 94 | 95 | The idea of this plugin has raised while working on a project in the public sector. After many research I found some plugins that guided me to the current solution. They have inspired me a lot, so many thanks to: 96 | 97 | - [Terry Zhao][zhaoterryy] the author of the [MkDocs PDF Export Plugin][mkdocs-pdf-export-plugin] the source of our inspiration. We've used some of his code in this project. 98 | - [Kozea team][kozeateam] for bringing [WeasyPrint](https://github.com/Kozea/WeasyPrint) to us as an open source project. The default design of the generated PDF is based on their work [report Sample](https://github.com/Kozea/WeasyPrint/tree/gh-pages/samples/report). 99 | - [Martin Donath][squidfunk] the author of [Material for MkDocs][materialmkdoc], some of his css file were used to design the layout of Admonition, Codehilite, Arthmatex, emoji, and more. 100 | 101 | 102 | [weasyprint-linux]: https://weasyprint.readthedocs.io/en/latest/install.html#linux 103 | [weasyprint-macos]: https://weasyprint.readthedocs.io/en/latest/install.html#macos 104 | [weasyprint-windows]: https://weasyprint.readthedocs.io/en/latest/install.html#windows 105 | [mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/ 106 | [github-issues]: https://github.com/comwes/mkpdfs-mkdocs-plugin/issues 107 | [contributing]: CONTRIBUTING.md 108 | [mkdocs-pdf-export-plugin]: https://github.com/zhaoterryy/mkdocs-pdf-export-plugin 109 | [kozeateam]: https://github.com/Kozea 110 | [zhaoterryy]: https://github.com/zhaoterryy 111 | [squidfunk]: https://github.com/squidfunk 112 | [materialmkdoc]: https://github.com/squidfunk/mkdocs-material 113 | -------------------------------------------------------------------------------- /design.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | from npm.bindings import npm_install, npm_run 5 | 6 | wd = os.getcwd() 7 | 8 | dir = os.path.dirname(os.path.realpath(__file__)) 9 | npm_install('{}/mkpdfs_mkdocs/design'.format(dir)) 10 | os.chdir('{}/mkpdfs_mkdocs/design'.format(dir)) 11 | stderr, stdout = npm_run('run', 'build-css') 12 | if stderr : 13 | sys.exit(stderr) 14 | print(stdout) 15 | os.chdir(wd) 16 | -------------------------------------------------------------------------------- /docs/assets/images/mkpdfs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/docs/assets/images/mkpdfs.png -------------------------------------------------------------------------------- /docs/getting-started.md: -------------------------------------------------------------------------------- 1 | ## Installation 2 | 3 | ### Installing MkDocs 4 | 5 | Before installing [MkDocs][1], you need to make sure you have Python and `pip` 6 | – the Python package manager – up and running. You can verify if you're already 7 | good to go with the following commands: 8 | 9 | [1]: https://www.mkdocs.org 10 | 11 | ``` sh 12 | python --version 13 | # Python 3.6.7 14 | pip --version 15 | # pip 19.0.3 16 | ``` 17 | 18 | > If you have multiple versions of python and python 3 is not your default version, use `pip3` instead of `pip` 19 | 20 | You have to also make sure all [requirements](index.md#requirements) are installed. 21 | 22 | Installing and verifying MkDocs is as simple as: 23 | 24 | ``` sh 25 | pip install mkdocs && mkdocs --version 26 | # mkdocs, version 1.0.4 27 | ``` 28 | 29 | ### Installing MkPDFs 30 | 31 | MkPDFs for MkDocs can be installed with `pip`, which is the prefered installation method. 32 | 33 | You just have to run the following command: 34 | 35 | ``` sh 36 | pip install mkpdfs-mkdocs 37 | ``` 38 | 39 | ## Configurations 40 | 41 | You can customise the layout of the generated PDF using exposed options presented in the folliwing table. 42 | 43 | | Option | Description | 44 | | --- | --- | 45 | | `author` | The author of the document. This information will be printed on the cover page of the generated PDF. | 46 | | `company` | If this documentation is from a company, then you should provide this information. It will be displayed on the front page of the documentation, bellow the author information| 47 | | `toc_title` | The table of content title. The default value is **Table of Contents** | 48 | | `toc_position` | The position of the table of contents. This option supports 3 differents values: `pre` to put the toc at the beginning of the file but after the cover (**the default value*), `post` to put it at the end of the file or `none` to not generate it at all. | 49 | | `output_path` | The file name of the generated PDF, relative to the `site_dir`. By default this location is set to `pdf/combined.pdf`| 50 | | `design` | Relative to your `MkDocs repository`, this option is the location of the CSS file defining the layout of the generated PDF. If this option is not defined the default design will be used. Defining an non existing file will cause the build or serve failure. | 51 | 52 | ### Configuration example 53 | Here is an example of configuration that you can adapt depending on your needs. 54 | 55 | ``` yaml 56 | plugins: 57 | - search 58 | - mkpdfs: 59 | company: The War Company Inc. 60 | author: Monsieur Silvestre 61 | toc_title: ToC 62 | ``` 63 | 64 | ### Hide file content from the generated PDF 65 | Sometime it can be interesting to hide a given documentation file from the PDF. 66 | 67 | This can be achieved by using the [Mkdocs YAML Style Meta-Data](https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data) features. 68 | 69 | For this, define a `pdf` metadata and set it to `False` in the top of your Markdown file like in the following example. 70 | 71 | ``` markdown 72 | --- 73 | pdf: False 74 | --- 75 | 76 | #Page title 77 | 78 | ``` 79 | 80 | ### Documentation design 81 | You have the ability to design the layout of your Generated PDF by using CSS. You can find out complete documentation by visiting our [Layout customisation](layout-design.md) section. 82 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # MkPDFs for MkDocs 2 | 3 | ### Generate nice documentation PDFs. 4 | 5 | MkPDFs for MkDocs is a plugin for [MkDocs][1], a nice static site generator 6 | designed for project documentation. 7 | 8 | [![MkPDFs for MkDocs](assets/images/mkpdfs.png)](assets/images/mkpdfs.png) 9 | 10 | 11 | What makes this plugin different to other MkDocs pdf generator plugins, is that it's not dependent to a given plugin and may work with absolutely any MkDocs theme. 12 | 13 | [1]: https://www.mkdocs.org 14 | 15 | ### Requirements 16 | Before you start, make sure that your system meets the following requirements: 17 | 18 | 1. MkDocs version 0.17.1 or higher 19 | 2. Python 3.4 or higher 20 | 3. It depends on WeasyPrint which depends on cairo, Pango and GDK-PixBuf. They need to be installed separately. Please follow your platform installation instructions carefully: 21 | - [Linux][weasyprint-linux] 22 | - [MacOS][weasyprint-macos] 23 | - [Windows][weasyprint-windows] 24 | 25 | ### Quick start 26 | Install the latest version of MkPDFs for MkDocs with `pip`: 27 | 28 | ``` sh 29 | pip3 install mkpdfs-mkdocs 30 | ``` 31 | 32 | Append the following line to your project's `mkdocs.yml`: 33 | 34 | ```yaml 35 | plugins: 36 | - search 37 | - mkpdfs 38 | ``` 39 | 40 | or with options 41 | 42 | ```yaml 43 | plugins: 44 | - search 45 | - mkpdfs: 46 | company: The War Company Inc. 47 | author: Monsieur Silvestre 48 | ``` 49 | 50 | ### Does it work? 51 | 52 | Now run `mkdocs serve` to run the dev server or `mkdocs build` to build your documentation. If the installation went, well you should see the following message: 53 | 54 | > The PDF version of the documentation has been generated. 55 | 56 | 57 | For detailed instructions see the [getting started guide][3]. 58 | 59 | [3]: getting-started.md 60 | 61 | [weasyprint-linux]: https://weasyprint.readthedocs.io/en/latest/install.html#linux 62 | [weasyprint-macos]: https://weasyprint.readthedocs.io/en/latest/install.html#macos 63 | [weasyprint-windows]: https://weasyprint.readthedocs.io/en/latest/install.html#windows 64 | -------------------------------------------------------------------------------- /docs/layout-design.md: -------------------------------------------------------------------------------- 1 | We have done our best to make sure that theme design will not interfer with the pdf design. They are completely separated to make it possible for you to customise and to avoid layout issues that we've encoutered while using other PDF generation plugins. 2 | 3 | With this plugin you can easily customise the design of your PDF by using CSS. 4 | 5 | ## Customisation 6 | 7 | Lets say you mkdoc schema is as following: 8 | 9 | ```bash 10 | . 11 | ├── design 12 | │   └── style.css 13 | ├── docs 14 | │   ├── index.md 15 | ├── mkdocs.yml 16 | ``` 17 | 18 | You can customise your PDF layout design by passing a CSS file location to the parameter `design` like in the folowing example. 19 | 20 | ```yaml 21 | plugins: 22 | - search 23 | - mkpdfs: 24 | design: design/style.css 25 | 26 | ``` 27 | 28 | !!! note Note 29 | Currently the plugin only supports the use of one file. 30 | 31 | The provided file location, must be relative to your MkDocs project folder. 32 | 33 | ### External url display 34 | It can sometime be interesting to display hidden external links to the file so users can copy-paste them. For that purpose we have added the class `external-links` to all external urls and you can add this feature by adding to your css file the following code. 35 | 36 | ```css 37 | .external-link::after { 38 | content: " (" attr(href) ")"; 39 | font-style: italic; 40 | } 41 | ``` 42 | 43 | ### Other CSS identifiers 44 | We have also exposed some style, that makes it easier to customise the Table of Contents, the document cover, the document title, the document author, the document company, and the copyright text. 45 | 46 | #### On the cover 47 | 48 | You can use the following css identifiers to modify your cover. 49 | 50 | - `#doc-cover`: Id of the cover containers. All elements are inside it. 51 | - `#doc-title`: The title container. You can use this to modify the apparence of the title present on the cover 52 | - `address`: This tag located in `#doc-cover` contains the author, company and the copyright information when they are available. 53 | - `p.author`: It contains the document author in the `#doc-cover`. 54 | - `p.company`: It contains the the document company in the `#doc-cover`. 55 | - `#copyright`: It contains the copyright text. This can be, as an example, added in the footer of each page. 56 | 57 | #### Pages Layout 58 | 59 | You can use the `@page` css to modify page layout. Please find more information at [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/@page). 60 | 61 | ## Built Layouts 62 | Our plan is to provide documentation layouts that can be used directly in your project. These built layouts will be available soon. Meanwhile you can also use the design sample to inspire you. 63 | 64 | ## Design sample 65 | We have created a design sample to ease this customisation step. You can find it on [Github](https://github.com/comwes/mkpdfs-design-sample). 66 | 67 | ### Usage 68 | 69 | In order to start using the design, a Node.js version of at least 8 is required. First, clone the repository: 70 | 71 | ``` sh 72 | git clone https://github.com/comwes/mkpdfs-design-sample 73 | ``` 74 | 75 | Next, all dependencies need to be installed, which is done with: 76 | 77 | ``` sh 78 | cd mkpdfs-design-sample 79 | npm install 80 | ``` 81 | 82 | ### Modifications 83 | Modify `scss` files as you need. In the `report.scss` you can modify two parameters to change the color main colors. 84 | - `$bgTextColor`: The text color when there's a background. 85 | - `$bgColor`: The document title color, background color and the titles colors on pages. 86 | 87 | ### Build the design 88 | To build the design, just run: 89 | 90 | ```sh 91 | npm run build 92 | ``` 93 | 94 | or if you want to build a compressed version 95 | 96 | ``` 97 | npm run build-compressed 98 | ``` 99 | 100 | You can now use the built css in your project. In the sample the css file to use is called `report.css` 101 | 102 | ### Run and build 103 | 104 | Now add enable MkPDFs plugin and include the design file in 'mkdocs.yml'. 105 | 106 | ```yaml 107 | plugins: 108 | - search 109 | - mkpdfs: 110 | design: mkpdfs-design-sample/report.css 111 | ``` 112 | 113 | Once the plugin has been enabled, you can now run one of these commands to see the result: 114 | 115 | ```bash 116 | # Berve the doc on localhost server 117 | mkdocs serve 118 | 119 | # Build the documentation 120 | mkdocs build 121 | ``` 122 | -------------------------------------------------------------------------------- /docs/release-notes.md: -------------------------------------------------------------------------------- 1 | 2 | ## Upgrading 3 | 4 | To upgrade MkPDFs to the latest version, use `pip`: 5 | 6 | ``` sh 7 | pip install --upgrade mkpdfs-mkdocs 8 | ``` 9 | 10 | To check the installed version, use the following command: 11 | 12 | ``` sh 13 | pip show mkpdfs-mkdocs 14 | ``` 15 | 16 | ## Changelog 17 | ### 1.0.1 - June 28, 2019 18 | 19 | * The plugin was breaking the documentation generation (#1). 20 | Now if the theme is not compatible, the PDF version of the documentation won't be created and a warning will be displayed without breaking the documentation generation. 21 | * Enhance the view by adding a section page in the documentation (#2) 22 | * Added the ability to remove the inclusion of some Markdown files in the generated pdf (#3) 23 | 24 | ### 1.0.0 - April 15, 2019 25 | 26 | * Initial release 27 | -------------------------------------------------------------------------------- /docs/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | @import "https://use.fontawesome.com/releases/v5.8.1/css/all.css"; 2 | 3 | a.pdf-download-btn{ 4 | font-size: .8rem; 5 | } 6 | 7 | a.pdf-download-btn small{ 8 | display: none; 9 | } 10 | -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: MkPDFs for MkDocs 2 | site_author: Comwes 3 | site_url: https://comwes.github.io/mkpdfs-mkdocs-plugin/ 4 | extra_css: 5 | - 'stylesheets/extra.css' 6 | theme: 7 | name: material 8 | language: 'en' 9 | font: 10 | text: 'Roboto' 11 | code: 'Roboto Mono' 12 | palette: 13 | primary: 'blue' 14 | accent: 'blue-light' 15 | repo_url: https://github.com/comwes/mkpdfs-mkdocs-plugin 16 | use_directory_urls: false 17 | edit_uri: "" 18 | # Copyright 19 | copyright: '© 2019 Comwes. CC-BY' 20 | nav: 21 | - 'MkPDFs': 'index.md' 22 | - 'Getting started': 'getting-started.md' 23 | - 'Layout customisation': 'layout-design.md' 24 | - 'Release notes': release-notes.md 25 | 26 | markdown_extensions: 27 | - admonition 28 | - footnotes 29 | - codehilite: 30 | guess_lang: false 31 | - toc: 32 | permalink: false 33 | plugins: 34 | - search 35 | - mkpdfs: 36 | author: Gerry Ntabuhashe 37 | company: "Comwes" 38 | toc_title: Table of contents 39 | output_path: pdf/documentation.pdf 40 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/__init__.py: -------------------------------------------------------------------------------- 1 | from .mkpdfs import Mkpdfs 2 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/FiraSans-Bold.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/FiraSans-Bold.otf -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/FiraSans-Italic.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/FiraSans-Italic.otf -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/FiraSans-Light.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/FiraSans-Light.otf -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/FiraSans-LightItalic.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/FiraSans-LightItalic.otf -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/FiraSans-Regular.otf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/FiraSans-Regular.otf -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/cover.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/cover.jpg -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/fonts/font-awesome.css: -------------------------------------------------------------------------------- 1 | /*! 2 | * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome 3 | * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) 4 | */ 5 | 6 | @font-face { 7 | font-family: FontAwesome; 8 | font-style: normal; 9 | font-weight: 400; 10 | src: url("specimen/FontAwesome.woff2") format("woff2"), 11 | url("specimen/FontAwesome.woff") format("woff"), 12 | url("specimen/FontAwesome.ttf") format("truetype"); 13 | } 14 | 15 | /* stylelint-disable */ 16 | 17 | .fa { 18 | display: inline-block; 19 | font: normal normal normal 14px/1 FontAwesome; 20 | font-size: inherit; 21 | text-rendering: auto; 22 | -webkit-font-smoothing: antialiased; 23 | -moz-osx-font-smoothing: grayscale 24 | } 25 | 26 | .fa-lg { 27 | font-size: 1.33333333em; 28 | line-height: .75em; 29 | vertical-align: -15% 30 | } 31 | 32 | .fa-2x { 33 | font-size: 2em 34 | } 35 | 36 | .fa-3x { 37 | font-size: 3em 38 | } 39 | 40 | .fa-4x { 41 | font-size: 4em 42 | } 43 | 44 | .fa-5x { 45 | font-size: 5em 46 | } 47 | 48 | .fa-fw { 49 | width: 1.28571429em; 50 | text-align: center 51 | } 52 | 53 | .fa-ul { 54 | padding-left: 0; 55 | margin-left: 2.14285714em; 56 | list-style-type: none 57 | } 58 | 59 | .fa-ul>li { 60 | position: relative 61 | } 62 | 63 | .fa-li { 64 | position: absolute; 65 | left: -2.14285714em; 66 | width: 2.14285714em; 67 | top: .14285714em; 68 | text-align: center 69 | } 70 | 71 | .fa-li.fa-lg { 72 | left: -1.85714286em 73 | } 74 | 75 | .fa-border { 76 | padding: .2em .25em .15em; 77 | border: solid .08em #eee; 78 | border-radius: .1em 79 | } 80 | 81 | .fa-pull-left { 82 | float: left 83 | } 84 | 85 | .fa-pull-right { 86 | float: right 87 | } 88 | 89 | .fa.fa-pull-left { 90 | margin-right: .3em 91 | } 92 | 93 | .fa.fa-pull-right { 94 | margin-left: .3em 95 | } 96 | 97 | .pull-right { 98 | float: right 99 | } 100 | 101 | .pull-left { 102 | float: left 103 | } 104 | 105 | .fa.pull-left { 106 | margin-right: .3em 107 | } 108 | 109 | .fa.pull-right { 110 | margin-left: .3em 111 | } 112 | 113 | .fa-spin { 114 | -webkit-animation: fa-spin 2s infinite linear; 115 | animation: fa-spin 2s infinite linear 116 | } 117 | 118 | .fa-pulse { 119 | -webkit-animation: fa-spin 1s infinite steps(8); 120 | animation: fa-spin 1s infinite steps(8) 121 | } 122 | 123 | @-webkit-keyframes fa-spin { 124 | 0% { 125 | -webkit-transform: rotate(0deg); 126 | transform: rotate(0deg) 127 | } 128 | 100% { 129 | -webkit-transform: rotate(359deg); 130 | transform: rotate(359deg) 131 | } 132 | } 133 | 134 | @keyframes fa-spin { 135 | 0% { 136 | -webkit-transform: rotate(0deg); 137 | transform: rotate(0deg) 138 | } 139 | 100% { 140 | -webkit-transform: rotate(359deg); 141 | transform: rotate(359deg) 142 | } 143 | } 144 | 145 | .fa-rotate-90 { 146 | -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=1)"; 147 | -webkit-transform: rotate(90deg); 148 | -ms-transform: rotate(90deg); 149 | transform: rotate(90deg) 150 | } 151 | 152 | .fa-rotate-180 { 153 | -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=2)"; 154 | -webkit-transform: rotate(180deg); 155 | -ms-transform: rotate(180deg); 156 | transform: rotate(180deg) 157 | } 158 | 159 | .fa-rotate-270 { 160 | -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=3)"; 161 | -webkit-transform: rotate(270deg); 162 | -ms-transform: rotate(270deg); 163 | transform: rotate(270deg) 164 | } 165 | 166 | .fa-flip-horizontal { 167 | -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)"; 168 | -webkit-transform: scale(-1, 1); 169 | -ms-transform: scale(-1, 1); 170 | transform: scale(-1, 1) 171 | } 172 | 173 | .fa-flip-vertical { 174 | -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)"; 175 | -webkit-transform: scale(1, -1); 176 | -ms-transform: scale(1, -1); 177 | transform: scale(1, -1) 178 | } 179 | 180 | :root .fa-rotate-90, :root .fa-rotate-180, :root .fa-rotate-270, :root .fa-flip-horizontal, :root .fa-flip-vertical { 181 | filter: none 182 | } 183 | 184 | .fa-stack { 185 | position: relative; 186 | display: inline-block; 187 | width: 2em; 188 | height: 2em; 189 | line-height: 2em; 190 | vertical-align: middle 191 | } 192 | 193 | .fa-stack-1x, .fa-stack-2x { 194 | position: absolute; 195 | left: 0; 196 | width: 100%; 197 | text-align: center 198 | } 199 | 200 | .fa-stack-1x { 201 | line-height: inherit 202 | } 203 | 204 | .fa-stack-2x { 205 | font-size: 2em 206 | } 207 | 208 | .fa-inverse { 209 | color: #fff 210 | } 211 | 212 | .fa-glass:before { 213 | content: "\f000" 214 | } 215 | 216 | .fa-music:before { 217 | content: "\f001" 218 | } 219 | 220 | .fa-search:before { 221 | content: "\f002" 222 | } 223 | 224 | .fa-envelope-o:before { 225 | content: "\f003" 226 | } 227 | 228 | .fa-heart:before { 229 | content: "\f004" 230 | } 231 | 232 | .fa-star:before { 233 | content: "\f005" 234 | } 235 | 236 | .fa-star-o:before { 237 | content: "\f006" 238 | } 239 | 240 | .fa-user:before { 241 | content: "\f007" 242 | } 243 | 244 | .fa-film:before { 245 | content: "\f008" 246 | } 247 | 248 | .fa-th-large:before { 249 | content: "\f009" 250 | } 251 | 252 | .fa-th:before { 253 | content: "\f00a" 254 | } 255 | 256 | .fa-th-list:before { 257 | content: "\f00b" 258 | } 259 | 260 | .fa-check:before { 261 | content: "\f00c" 262 | } 263 | 264 | .fa-remove:before, .fa-close:before, .fa-times:before { 265 | content: "\f00d" 266 | } 267 | 268 | .fa-search-plus:before { 269 | content: "\f00e" 270 | } 271 | 272 | .fa-search-minus:before { 273 | content: "\f010" 274 | } 275 | 276 | .fa-power-off:before { 277 | content: "\f011" 278 | } 279 | 280 | .fa-signal:before { 281 | content: "\f012" 282 | } 283 | 284 | .fa-gear:before, .fa-cog:before { 285 | content: "\f013" 286 | } 287 | 288 | .fa-trash-o:before { 289 | content: "\f014" 290 | } 291 | 292 | .fa-home:before { 293 | content: "\f015" 294 | } 295 | 296 | .fa-file-o:before { 297 | content: "\f016" 298 | } 299 | 300 | .fa-clock-o:before { 301 | content: "\f017" 302 | } 303 | 304 | .fa-road:before { 305 | content: "\f018" 306 | } 307 | 308 | .fa-download:before { 309 | content: "\f019" 310 | } 311 | 312 | .fa-arrow-circle-o-down:before { 313 | content: "\f01a" 314 | } 315 | 316 | .fa-arrow-circle-o-up:before { 317 | content: "\f01b" 318 | } 319 | 320 | .fa-inbox:before { 321 | content: "\f01c" 322 | } 323 | 324 | .fa-play-circle-o:before { 325 | content: "\f01d" 326 | } 327 | 328 | .fa-rotate-right:before, .fa-repeat:before { 329 | content: "\f01e" 330 | } 331 | 332 | .fa-refresh:before { 333 | content: "\f021" 334 | } 335 | 336 | .fa-list-alt:before { 337 | content: "\f022" 338 | } 339 | 340 | .fa-lock:before { 341 | content: "\f023" 342 | } 343 | 344 | .fa-flag:before { 345 | content: "\f024" 346 | } 347 | 348 | .fa-headphones:before { 349 | content: "\f025" 350 | } 351 | 352 | .fa-volume-off:before { 353 | content: "\f026" 354 | } 355 | 356 | .fa-volume-down:before { 357 | content: "\f027" 358 | } 359 | 360 | .fa-volume-up:before { 361 | content: "\f028" 362 | } 363 | 364 | .fa-qrcode:before { 365 | content: "\f029" 366 | } 367 | 368 | .fa-barcode:before { 369 | content: "\f02a" 370 | } 371 | 372 | .fa-tag:before { 373 | content: "\f02b" 374 | } 375 | 376 | .fa-tags:before { 377 | content: "\f02c" 378 | } 379 | 380 | .fa-book:before { 381 | content: "\f02d" 382 | } 383 | 384 | .fa-bookmark:before { 385 | content: "\f02e" 386 | } 387 | 388 | .fa-print:before { 389 | content: "\f02f" 390 | } 391 | 392 | .fa-camera:before { 393 | content: "\f030" 394 | } 395 | 396 | .fa-font:before { 397 | content: "\f031" 398 | } 399 | 400 | .fa-bold:before { 401 | content: "\f032" 402 | } 403 | 404 | .fa-italic:before { 405 | content: "\f033" 406 | } 407 | 408 | .fa-text-height:before { 409 | content: "\f034" 410 | } 411 | 412 | .fa-text-width:before { 413 | content: "\f035" 414 | } 415 | 416 | .fa-align-left:before { 417 | content: "\f036" 418 | } 419 | 420 | .fa-align-center:before { 421 | content: "\f037" 422 | } 423 | 424 | .fa-align-right:before { 425 | content: "\f038" 426 | } 427 | 428 | .fa-align-justify:before { 429 | content: "\f039" 430 | } 431 | 432 | .fa-list:before { 433 | content: "\f03a" 434 | } 435 | 436 | .fa-dedent:before, .fa-outdent:before { 437 | content: "\f03b" 438 | } 439 | 440 | .fa-indent:before { 441 | content: "\f03c" 442 | } 443 | 444 | .fa-video-camera:before { 445 | content: "\f03d" 446 | } 447 | 448 | .fa-photo:before, .fa-image:before, .fa-picture-o:before { 449 | content: "\f03e" 450 | } 451 | 452 | .fa-pencil:before { 453 | content: "\f040" 454 | } 455 | 456 | .fa-map-marker:before { 457 | content: "\f041" 458 | } 459 | 460 | .fa-adjust:before { 461 | content: "\f042" 462 | } 463 | 464 | .fa-tint:before { 465 | content: "\f043" 466 | } 467 | 468 | .fa-edit:before, .fa-pencil-square-o:before { 469 | content: "\f044" 470 | } 471 | 472 | .fa-share-square-o:before { 473 | content: "\f045" 474 | } 475 | 476 | .fa-check-square-o:before { 477 | content: "\f046" 478 | } 479 | 480 | .fa-arrows:before { 481 | content: "\f047" 482 | } 483 | 484 | .fa-step-backward:before { 485 | content: "\f048" 486 | } 487 | 488 | .fa-fast-backward:before { 489 | content: "\f049" 490 | } 491 | 492 | .fa-backward:before { 493 | content: "\f04a" 494 | } 495 | 496 | .fa-play:before { 497 | content: "\f04b" 498 | } 499 | 500 | .fa-pause:before { 501 | content: "\f04c" 502 | } 503 | 504 | .fa-stop:before { 505 | content: "\f04d" 506 | } 507 | 508 | .fa-forward:before { 509 | content: "\f04e" 510 | } 511 | 512 | .fa-fast-forward:before { 513 | content: "\f050" 514 | } 515 | 516 | .fa-step-forward:before { 517 | content: "\f051" 518 | } 519 | 520 | .fa-eject:before { 521 | content: "\f052" 522 | } 523 | 524 | .fa-chevron-left:before { 525 | content: "\f053" 526 | } 527 | 528 | .fa-chevron-right:before { 529 | content: "\f054" 530 | } 531 | 532 | .fa-plus-circle:before { 533 | content: "\f055" 534 | } 535 | 536 | .fa-minus-circle:before { 537 | content: "\f056" 538 | } 539 | 540 | .fa-times-circle:before { 541 | content: "\f057" 542 | } 543 | 544 | .fa-check-circle:before { 545 | content: "\f058" 546 | } 547 | 548 | .fa-question-circle:before { 549 | content: "\f059" 550 | } 551 | 552 | .fa-info-circle:before { 553 | content: "\f05a" 554 | } 555 | 556 | .fa-crosshairs:before { 557 | content: "\f05b" 558 | } 559 | 560 | .fa-times-circle-o:before { 561 | content: "\f05c" 562 | } 563 | 564 | .fa-check-circle-o:before { 565 | content: "\f05d" 566 | } 567 | 568 | .fa-ban:before { 569 | content: "\f05e" 570 | } 571 | 572 | .fa-arrow-left:before { 573 | content: "\f060" 574 | } 575 | 576 | .fa-arrow-right:before { 577 | content: "\f061" 578 | } 579 | 580 | .fa-arrow-up:before { 581 | content: "\f062" 582 | } 583 | 584 | .fa-arrow-down:before { 585 | content: "\f063" 586 | } 587 | 588 | .fa-mail-forward:before, .fa-share:before { 589 | content: "\f064" 590 | } 591 | 592 | .fa-expand:before { 593 | content: "\f065" 594 | } 595 | 596 | .fa-compress:before { 597 | content: "\f066" 598 | } 599 | 600 | .fa-plus:before { 601 | content: "\f067" 602 | } 603 | 604 | .fa-minus:before { 605 | content: "\f068" 606 | } 607 | 608 | .fa-asterisk:before { 609 | content: "\f069" 610 | } 611 | 612 | .fa-exclamation-circle:before { 613 | content: "\f06a" 614 | } 615 | 616 | .fa-gift:before { 617 | content: "\f06b" 618 | } 619 | 620 | .fa-leaf:before { 621 | content: "\f06c" 622 | } 623 | 624 | .fa-fire:before { 625 | content: "\f06d" 626 | } 627 | 628 | .fa-eye:before { 629 | content: "\f06e" 630 | } 631 | 632 | .fa-eye-slash:before { 633 | content: "\f070" 634 | } 635 | 636 | .fa-warning:before, .fa-exclamation-triangle:before { 637 | content: "\f071" 638 | } 639 | 640 | .fa-plane:before { 641 | content: "\f072" 642 | } 643 | 644 | .fa-calendar:before { 645 | content: "\f073" 646 | } 647 | 648 | .fa-random:before { 649 | content: "\f074" 650 | } 651 | 652 | .fa-comment:before { 653 | content: "\f075" 654 | } 655 | 656 | .fa-magnet:before { 657 | content: "\f076" 658 | } 659 | 660 | .fa-chevron-up:before { 661 | content: "\f077" 662 | } 663 | 664 | .fa-chevron-down:before { 665 | content: "\f078" 666 | } 667 | 668 | .fa-retweet:before { 669 | content: "\f079" 670 | } 671 | 672 | .fa-shopping-cart:before { 673 | content: "\f07a" 674 | } 675 | 676 | .fa-folder:before { 677 | content: "\f07b" 678 | } 679 | 680 | .fa-folder-open:before { 681 | content: "\f07c" 682 | } 683 | 684 | .fa-arrows-v:before { 685 | content: "\f07d" 686 | } 687 | 688 | .fa-arrows-h:before { 689 | content: "\f07e" 690 | } 691 | 692 | .fa-bar-chart-o:before, .fa-bar-chart:before { 693 | content: "\f080" 694 | } 695 | 696 | .fa-twitter-square:before { 697 | content: "\f081" 698 | } 699 | 700 | .fa-facebook-square:before { 701 | content: "\f082" 702 | } 703 | 704 | .fa-camera-retro:before { 705 | content: "\f083" 706 | } 707 | 708 | .fa-key:before { 709 | content: "\f084" 710 | } 711 | 712 | .fa-gears:before, .fa-cogs:before { 713 | content: "\f085" 714 | } 715 | 716 | .fa-comments:before { 717 | content: "\f086" 718 | } 719 | 720 | .fa-thumbs-o-up:before { 721 | content: "\f087" 722 | } 723 | 724 | .fa-thumbs-o-down:before { 725 | content: "\f088" 726 | } 727 | 728 | .fa-star-half:before { 729 | content: "\f089" 730 | } 731 | 732 | .fa-heart-o:before { 733 | content: "\f08a" 734 | } 735 | 736 | .fa-sign-out:before { 737 | content: "\f08b" 738 | } 739 | 740 | .fa-linkedin-square:before { 741 | content: "\f08c" 742 | } 743 | 744 | .fa-thumb-tack:before { 745 | content: "\f08d" 746 | } 747 | 748 | .fa-external-link:before { 749 | content: "\f08e" 750 | } 751 | 752 | .fa-sign-in:before { 753 | content: "\f090" 754 | } 755 | 756 | .fa-trophy:before { 757 | content: "\f091" 758 | } 759 | 760 | .fa-github-square:before { 761 | content: "\f092" 762 | } 763 | 764 | .fa-upload:before { 765 | content: "\f093" 766 | } 767 | 768 | .fa-lemon-o:before { 769 | content: "\f094" 770 | } 771 | 772 | .fa-phone:before { 773 | content: "\f095" 774 | } 775 | 776 | .fa-square-o:before { 777 | content: "\f096" 778 | } 779 | 780 | .fa-bookmark-o:before { 781 | content: "\f097" 782 | } 783 | 784 | .fa-phone-square:before { 785 | content: "\f098" 786 | } 787 | 788 | .fa-twitter:before { 789 | content: "\f099" 790 | } 791 | 792 | .fa-facebook-f:before, .fa-facebook:before { 793 | content: "\f09a" 794 | } 795 | 796 | .fa-github:before { 797 | content: "\f09b" 798 | } 799 | 800 | .fa-unlock:before { 801 | content: "\f09c" 802 | } 803 | 804 | .fa-credit-card:before { 805 | content: "\f09d" 806 | } 807 | 808 | .fa-feed:before, .fa-rss:before { 809 | content: "\f09e" 810 | } 811 | 812 | .fa-hdd-o:before { 813 | content: "\f0a0" 814 | } 815 | 816 | .fa-bullhorn:before { 817 | content: "\f0a1" 818 | } 819 | 820 | .fa-bell:before { 821 | content: "\f0f3" 822 | } 823 | 824 | .fa-certificate:before { 825 | content: "\f0a3" 826 | } 827 | 828 | .fa-hand-o-right:before { 829 | content: "\f0a4" 830 | } 831 | 832 | .fa-hand-o-left:before { 833 | content: "\f0a5" 834 | } 835 | 836 | .fa-hand-o-up:before { 837 | content: "\f0a6" 838 | } 839 | 840 | .fa-hand-o-down:before { 841 | content: "\f0a7" 842 | } 843 | 844 | .fa-arrow-circle-left:before { 845 | content: "\f0a8" 846 | } 847 | 848 | .fa-arrow-circle-right:before { 849 | content: "\f0a9" 850 | } 851 | 852 | .fa-arrow-circle-up:before { 853 | content: "\f0aa" 854 | } 855 | 856 | .fa-arrow-circle-down:before { 857 | content: "\f0ab" 858 | } 859 | 860 | .fa-globe:before { 861 | content: "\f0ac" 862 | } 863 | 864 | .fa-wrench:before { 865 | content: "\f0ad" 866 | } 867 | 868 | .fa-tasks:before { 869 | content: "\f0ae" 870 | } 871 | 872 | .fa-filter:before { 873 | content: "\f0b0" 874 | } 875 | 876 | .fa-briefcase:before { 877 | content: "\f0b1" 878 | } 879 | 880 | .fa-arrows-alt:before { 881 | content: "\f0b2" 882 | } 883 | 884 | .fa-group:before, .fa-users:before { 885 | content: "\f0c0" 886 | } 887 | 888 | .fa-chain:before, .fa-link:before { 889 | content: "\f0c1" 890 | } 891 | 892 | .fa-cloud:before { 893 | content: "\f0c2" 894 | } 895 | 896 | .fa-flask:before { 897 | content: "\f0c3" 898 | } 899 | 900 | .fa-cut:before, .fa-scissors:before { 901 | content: "\f0c4" 902 | } 903 | 904 | .fa-copy:before, .fa-files-o:before { 905 | content: "\f0c5" 906 | } 907 | 908 | .fa-paperclip:before { 909 | content: "\f0c6" 910 | } 911 | 912 | .fa-save:before, .fa-floppy-o:before { 913 | content: "\f0c7" 914 | } 915 | 916 | .fa-square:before { 917 | content: "\f0c8" 918 | } 919 | 920 | .fa-navicon:before, .fa-reorder:before, .fa-bars:before { 921 | content: "\f0c9" 922 | } 923 | 924 | .fa-list-ul:before { 925 | content: "\f0ca" 926 | } 927 | 928 | .fa-list-ol:before { 929 | content: "\f0cb" 930 | } 931 | 932 | .fa-strikethrough:before { 933 | content: "\f0cc" 934 | } 935 | 936 | .fa-underline:before { 937 | content: "\f0cd" 938 | } 939 | 940 | .fa-table:before { 941 | content: "\f0ce" 942 | } 943 | 944 | .fa-magic:before { 945 | content: "\f0d0" 946 | } 947 | 948 | .fa-truck:before { 949 | content: "\f0d1" 950 | } 951 | 952 | .fa-pinterest:before { 953 | content: "\f0d2" 954 | } 955 | 956 | .fa-pinterest-square:before { 957 | content: "\f0d3" 958 | } 959 | 960 | .fa-google-plus-square:before { 961 | content: "\f0d4" 962 | } 963 | 964 | .fa-google-plus:before { 965 | content: "\f0d5" 966 | } 967 | 968 | .fa-money:before { 969 | content: "\f0d6" 970 | } 971 | 972 | .fa-caret-down:before { 973 | content: "\f0d7" 974 | } 975 | 976 | .fa-caret-up:before { 977 | content: "\f0d8" 978 | } 979 | 980 | .fa-caret-left:before { 981 | content: "\f0d9" 982 | } 983 | 984 | .fa-caret-right:before { 985 | content: "\f0da" 986 | } 987 | 988 | .fa-columns:before { 989 | content: "\f0db" 990 | } 991 | 992 | .fa-unsorted:before, .fa-sort:before { 993 | content: "\f0dc" 994 | } 995 | 996 | .fa-sort-down:before, .fa-sort-desc:before { 997 | content: "\f0dd" 998 | } 999 | 1000 | .fa-sort-up:before, .fa-sort-asc:before { 1001 | content: "\f0de" 1002 | } 1003 | 1004 | .fa-envelope:before { 1005 | content: "\f0e0" 1006 | } 1007 | 1008 | .fa-linkedin:before { 1009 | content: "\f0e1" 1010 | } 1011 | 1012 | .fa-rotate-left:before, .fa-undo:before { 1013 | content: "\f0e2" 1014 | } 1015 | 1016 | .fa-legal:before, .fa-gavel:before { 1017 | content: "\f0e3" 1018 | } 1019 | 1020 | .fa-dashboard:before, .fa-tachometer:before { 1021 | content: "\f0e4" 1022 | } 1023 | 1024 | .fa-comment-o:before { 1025 | content: "\f0e5" 1026 | } 1027 | 1028 | .fa-comments-o:before { 1029 | content: "\f0e6" 1030 | } 1031 | 1032 | .fa-flash:before, .fa-bolt:before { 1033 | content: "\f0e7" 1034 | } 1035 | 1036 | .fa-sitemap:before { 1037 | content: "\f0e8" 1038 | } 1039 | 1040 | .fa-umbrella:before { 1041 | content: "\f0e9" 1042 | } 1043 | 1044 | .fa-paste:before, .fa-clipboard:before { 1045 | content: "\f0ea" 1046 | } 1047 | 1048 | .fa-lightbulb-o:before { 1049 | content: "\f0eb" 1050 | } 1051 | 1052 | .fa-exchange:before { 1053 | content: "\f0ec" 1054 | } 1055 | 1056 | .fa-cloud-download:before { 1057 | content: "\f0ed" 1058 | } 1059 | 1060 | .fa-cloud-upload:before { 1061 | content: "\f0ee" 1062 | } 1063 | 1064 | .fa-user-md:before { 1065 | content: "\f0f0" 1066 | } 1067 | 1068 | .fa-stethoscope:before { 1069 | content: "\f0f1" 1070 | } 1071 | 1072 | .fa-suitcase:before { 1073 | content: "\f0f2" 1074 | } 1075 | 1076 | .fa-bell-o:before { 1077 | content: "\f0a2" 1078 | } 1079 | 1080 | .fa-coffee:before { 1081 | content: "\f0f4" 1082 | } 1083 | 1084 | .fa-cutlery:before { 1085 | content: "\f0f5" 1086 | } 1087 | 1088 | .fa-file-text-o:before { 1089 | content: "\f0f6" 1090 | } 1091 | 1092 | .fa-building-o:before { 1093 | content: "\f0f7" 1094 | } 1095 | 1096 | .fa-hospital-o:before { 1097 | content: "\f0f8" 1098 | } 1099 | 1100 | .fa-ambulance:before { 1101 | content: "\f0f9" 1102 | } 1103 | 1104 | .fa-medkit:before { 1105 | content: "\f0fa" 1106 | } 1107 | 1108 | .fa-fighter-jet:before { 1109 | content: "\f0fb" 1110 | } 1111 | 1112 | .fa-beer:before { 1113 | content: "\f0fc" 1114 | } 1115 | 1116 | .fa-h-square:before { 1117 | content: "\f0fd" 1118 | } 1119 | 1120 | .fa-plus-square:before { 1121 | content: "\f0fe" 1122 | } 1123 | 1124 | .fa-angle-double-left:before { 1125 | content: "\f100" 1126 | } 1127 | 1128 | .fa-angle-double-right:before { 1129 | content: "\f101" 1130 | } 1131 | 1132 | .fa-angle-double-up:before { 1133 | content: "\f102" 1134 | } 1135 | 1136 | .fa-angle-double-down:before { 1137 | content: "\f103" 1138 | } 1139 | 1140 | .fa-angle-left:before { 1141 | content: "\f104" 1142 | } 1143 | 1144 | .fa-angle-right:before { 1145 | content: "\f105" 1146 | } 1147 | 1148 | .fa-angle-up:before { 1149 | content: "\f106" 1150 | } 1151 | 1152 | .fa-angle-down:before { 1153 | content: "\f107" 1154 | } 1155 | 1156 | .fa-desktop:before { 1157 | content: "\f108" 1158 | } 1159 | 1160 | .fa-laptop:before { 1161 | content: "\f109" 1162 | } 1163 | 1164 | .fa-tablet:before { 1165 | content: "\f10a" 1166 | } 1167 | 1168 | .fa-mobile-phone:before, .fa-mobile:before { 1169 | content: "\f10b" 1170 | } 1171 | 1172 | .fa-circle-o:before { 1173 | content: "\f10c" 1174 | } 1175 | 1176 | .fa-quote-left:before { 1177 | content: "\f10d" 1178 | } 1179 | 1180 | .fa-quote-right:before { 1181 | content: "\f10e" 1182 | } 1183 | 1184 | .fa-spinner:before { 1185 | content: "\f110" 1186 | } 1187 | 1188 | .fa-circle:before { 1189 | content: "\f111" 1190 | } 1191 | 1192 | .fa-mail-reply:before, .fa-reply:before { 1193 | content: "\f112" 1194 | } 1195 | 1196 | .fa-github-alt:before { 1197 | content: "\f113" 1198 | } 1199 | 1200 | .fa-folder-o:before { 1201 | content: "\f114" 1202 | } 1203 | 1204 | .fa-folder-open-o:before { 1205 | content: "\f115" 1206 | } 1207 | 1208 | .fa-smile-o:before { 1209 | content: "\f118" 1210 | } 1211 | 1212 | .fa-frown-o:before { 1213 | content: "\f119" 1214 | } 1215 | 1216 | .fa-meh-o:before { 1217 | content: "\f11a" 1218 | } 1219 | 1220 | .fa-gamepad:before { 1221 | content: "\f11b" 1222 | } 1223 | 1224 | .fa-keyboard-o:before { 1225 | content: "\f11c" 1226 | } 1227 | 1228 | .fa-flag-o:before { 1229 | content: "\f11d" 1230 | } 1231 | 1232 | .fa-flag-checkered:before { 1233 | content: "\f11e" 1234 | } 1235 | 1236 | .fa-terminal:before { 1237 | content: "\f120" 1238 | } 1239 | 1240 | .fa-code:before { 1241 | content: "\f121" 1242 | } 1243 | 1244 | .fa-mail-reply-all:before, .fa-reply-all:before { 1245 | content: "\f122" 1246 | } 1247 | 1248 | .fa-star-half-empty:before, .fa-star-half-full:before, .fa-star-half-o:before { 1249 | content: "\f123" 1250 | } 1251 | 1252 | .fa-location-arrow:before { 1253 | content: "\f124" 1254 | } 1255 | 1256 | .fa-crop:before { 1257 | content: "\f125" 1258 | } 1259 | 1260 | .fa-code-fork:before { 1261 | content: "\f126" 1262 | } 1263 | 1264 | .fa-unlink:before, .fa-chain-broken:before { 1265 | content: "\f127" 1266 | } 1267 | 1268 | .fa-question:before { 1269 | content: "\f128" 1270 | } 1271 | 1272 | .fa-info:before { 1273 | content: "\f129" 1274 | } 1275 | 1276 | .fa-exclamation:before { 1277 | content: "\f12a" 1278 | } 1279 | 1280 | .fa-superscript:before { 1281 | content: "\f12b" 1282 | } 1283 | 1284 | .fa-subscript:before { 1285 | content: "\f12c" 1286 | } 1287 | 1288 | .fa-eraser:before { 1289 | content: "\f12d" 1290 | } 1291 | 1292 | .fa-puzzle-piece:before { 1293 | content: "\f12e" 1294 | } 1295 | 1296 | .fa-microphone:before { 1297 | content: "\f130" 1298 | } 1299 | 1300 | .fa-microphone-slash:before { 1301 | content: "\f131" 1302 | } 1303 | 1304 | .fa-shield:before { 1305 | content: "\f132" 1306 | } 1307 | 1308 | .fa-calendar-o:before { 1309 | content: "\f133" 1310 | } 1311 | 1312 | .fa-fire-extinguisher:before { 1313 | content: "\f134" 1314 | } 1315 | 1316 | .fa-rocket:before { 1317 | content: "\f135" 1318 | } 1319 | 1320 | .fa-maxcdn:before { 1321 | content: "\f136" 1322 | } 1323 | 1324 | .fa-chevron-circle-left:before { 1325 | content: "\f137" 1326 | } 1327 | 1328 | .fa-chevron-circle-right:before { 1329 | content: "\f138" 1330 | } 1331 | 1332 | .fa-chevron-circle-up:before { 1333 | content: "\f139" 1334 | } 1335 | 1336 | .fa-chevron-circle-down:before { 1337 | content: "\f13a" 1338 | } 1339 | 1340 | .fa-html5:before { 1341 | content: "\f13b" 1342 | } 1343 | 1344 | .fa-css3:before { 1345 | content: "\f13c" 1346 | } 1347 | 1348 | .fa-anchor:before { 1349 | content: "\f13d" 1350 | } 1351 | 1352 | .fa-unlock-alt:before { 1353 | content: "\f13e" 1354 | } 1355 | 1356 | .fa-bullseye:before { 1357 | content: "\f140" 1358 | } 1359 | 1360 | .fa-ellipsis-h:before { 1361 | content: "\f141" 1362 | } 1363 | 1364 | .fa-ellipsis-v:before { 1365 | content: "\f142" 1366 | } 1367 | 1368 | .fa-rss-square:before { 1369 | content: "\f143" 1370 | } 1371 | 1372 | .fa-play-circle:before { 1373 | content: "\f144" 1374 | } 1375 | 1376 | .fa-ticket:before { 1377 | content: "\f145" 1378 | } 1379 | 1380 | .fa-minus-square:before { 1381 | content: "\f146" 1382 | } 1383 | 1384 | .fa-minus-square-o:before { 1385 | content: "\f147" 1386 | } 1387 | 1388 | .fa-level-up:before { 1389 | content: "\f148" 1390 | } 1391 | 1392 | .fa-level-down:before { 1393 | content: "\f149" 1394 | } 1395 | 1396 | .fa-check-square:before { 1397 | content: "\f14a" 1398 | } 1399 | 1400 | .fa-pencil-square:before { 1401 | content: "\f14b" 1402 | } 1403 | 1404 | .fa-external-link-square:before { 1405 | content: "\f14c" 1406 | } 1407 | 1408 | .fa-share-square:before { 1409 | content: "\f14d" 1410 | } 1411 | 1412 | .fa-compass:before { 1413 | content: "\f14e" 1414 | } 1415 | 1416 | .fa-toggle-down:before, .fa-caret-square-o-down:before { 1417 | content: "\f150" 1418 | } 1419 | 1420 | .fa-toggle-up:before, .fa-caret-square-o-up:before { 1421 | content: "\f151" 1422 | } 1423 | 1424 | .fa-toggle-right:before, .fa-caret-square-o-right:before { 1425 | content: "\f152" 1426 | } 1427 | 1428 | .fa-euro:before, .fa-eur:before { 1429 | content: "\f153" 1430 | } 1431 | 1432 | .fa-gbp:before { 1433 | content: "\f154" 1434 | } 1435 | 1436 | .fa-dollar:before, .fa-usd:before { 1437 | content: "\f155" 1438 | } 1439 | 1440 | .fa-rupee:before, .fa-inr:before { 1441 | content: "\f156" 1442 | } 1443 | 1444 | .fa-cny:before, .fa-rmb:before, .fa-yen:before, .fa-jpy:before { 1445 | content: "\f157" 1446 | } 1447 | 1448 | .fa-ruble:before, .fa-rouble:before, .fa-rub:before { 1449 | content: "\f158" 1450 | } 1451 | 1452 | .fa-won:before, .fa-krw:before { 1453 | content: "\f159" 1454 | } 1455 | 1456 | .fa-bitcoin:before, .fa-btc:before { 1457 | content: "\f15a" 1458 | } 1459 | 1460 | .fa-file:before { 1461 | content: "\f15b" 1462 | } 1463 | 1464 | .fa-file-text:before { 1465 | content: "\f15c" 1466 | } 1467 | 1468 | .fa-sort-alpha-asc:before { 1469 | content: "\f15d" 1470 | } 1471 | 1472 | .fa-sort-alpha-desc:before { 1473 | content: "\f15e" 1474 | } 1475 | 1476 | .fa-sort-amount-asc:before { 1477 | content: "\f160" 1478 | } 1479 | 1480 | .fa-sort-amount-desc:before { 1481 | content: "\f161" 1482 | } 1483 | 1484 | .fa-sort-numeric-asc:before { 1485 | content: "\f162" 1486 | } 1487 | 1488 | .fa-sort-numeric-desc:before { 1489 | content: "\f163" 1490 | } 1491 | 1492 | .fa-thumbs-up:before { 1493 | content: "\f164" 1494 | } 1495 | 1496 | .fa-thumbs-down:before { 1497 | content: "\f165" 1498 | } 1499 | 1500 | .fa-youtube-square:before { 1501 | content: "\f166" 1502 | } 1503 | 1504 | .fa-youtube:before { 1505 | content: "\f167" 1506 | } 1507 | 1508 | .fa-xing:before { 1509 | content: "\f168" 1510 | } 1511 | 1512 | .fa-xing-square:before { 1513 | content: "\f169" 1514 | } 1515 | 1516 | .fa-youtube-play:before { 1517 | content: "\f16a" 1518 | } 1519 | 1520 | .fa-dropbox:before { 1521 | content: "\f16b" 1522 | } 1523 | 1524 | .fa-stack-overflow:before { 1525 | content: "\f16c" 1526 | } 1527 | 1528 | .fa-instagram:before { 1529 | content: "\f16d" 1530 | } 1531 | 1532 | .fa-flickr:before { 1533 | content: "\f16e" 1534 | } 1535 | 1536 | .fa-adn:before { 1537 | content: "\f170" 1538 | } 1539 | 1540 | .fa-bitbucket:before { 1541 | content: "\f171" 1542 | } 1543 | 1544 | .fa-bitbucket-square:before { 1545 | content: "\f172" 1546 | } 1547 | 1548 | .fa-tumblr:before { 1549 | content: "\f173" 1550 | } 1551 | 1552 | .fa-tumblr-square:before { 1553 | content: "\f174" 1554 | } 1555 | 1556 | .fa-long-arrow-down:before { 1557 | content: "\f175" 1558 | } 1559 | 1560 | .fa-long-arrow-up:before { 1561 | content: "\f176" 1562 | } 1563 | 1564 | .fa-long-arrow-left:before { 1565 | content: "\f177" 1566 | } 1567 | 1568 | .fa-long-arrow-right:before { 1569 | content: "\f178" 1570 | } 1571 | 1572 | .fa-apple:before { 1573 | content: "\f179" 1574 | } 1575 | 1576 | .fa-windows:before { 1577 | content: "\f17a" 1578 | } 1579 | 1580 | .fa-android:before { 1581 | content: "\f17b" 1582 | } 1583 | 1584 | .fa-linux:before { 1585 | content: "\f17c" 1586 | } 1587 | 1588 | .fa-dribbble:before { 1589 | content: "\f17d" 1590 | } 1591 | 1592 | .fa-skype:before { 1593 | content: "\f17e" 1594 | } 1595 | 1596 | .fa-foursquare:before { 1597 | content: "\f180" 1598 | } 1599 | 1600 | .fa-trello:before { 1601 | content: "\f181" 1602 | } 1603 | 1604 | .fa-female:before { 1605 | content: "\f182" 1606 | } 1607 | 1608 | .fa-male:before { 1609 | content: "\f183" 1610 | } 1611 | 1612 | .fa-gittip:before, .fa-gratipay:before { 1613 | content: "\f184" 1614 | } 1615 | 1616 | .fa-sun-o:before { 1617 | content: "\f185" 1618 | } 1619 | 1620 | .fa-moon-o:before { 1621 | content: "\f186" 1622 | } 1623 | 1624 | .fa-archive:before { 1625 | content: "\f187" 1626 | } 1627 | 1628 | .fa-bug:before { 1629 | content: "\f188" 1630 | } 1631 | 1632 | .fa-vk:before { 1633 | content: "\f189" 1634 | } 1635 | 1636 | .fa-weibo:before { 1637 | content: "\f18a" 1638 | } 1639 | 1640 | .fa-renren:before { 1641 | content: "\f18b" 1642 | } 1643 | 1644 | .fa-pagelines:before { 1645 | content: "\f18c" 1646 | } 1647 | 1648 | .fa-stack-exchange:before { 1649 | content: "\f18d" 1650 | } 1651 | 1652 | .fa-arrow-circle-o-right:before { 1653 | content: "\f18e" 1654 | } 1655 | 1656 | .fa-arrow-circle-o-left:before { 1657 | content: "\f190" 1658 | } 1659 | 1660 | .fa-toggle-left:before, .fa-caret-square-o-left:before { 1661 | content: "\f191" 1662 | } 1663 | 1664 | .fa-dot-circle-o:before { 1665 | content: "\f192" 1666 | } 1667 | 1668 | .fa-wheelchair:before { 1669 | content: "\f193" 1670 | } 1671 | 1672 | .fa-vimeo-square:before { 1673 | content: "\f194" 1674 | } 1675 | 1676 | .fa-turkish-lira:before, .fa-try:before { 1677 | content: "\f195" 1678 | } 1679 | 1680 | .fa-plus-square-o:before { 1681 | content: "\f196" 1682 | } 1683 | 1684 | .fa-space-shuttle:before { 1685 | content: "\f197" 1686 | } 1687 | 1688 | .fa-slack:before { 1689 | content: "\f198" 1690 | } 1691 | 1692 | .fa-envelope-square:before { 1693 | content: "\f199" 1694 | } 1695 | 1696 | .fa-wordpress:before { 1697 | content: "\f19a" 1698 | } 1699 | 1700 | .fa-openid:before { 1701 | content: "\f19b" 1702 | } 1703 | 1704 | .fa-institution:before, .fa-bank:before, .fa-university:before { 1705 | content: "\f19c" 1706 | } 1707 | 1708 | .fa-mortar-board:before, .fa-graduation-cap:before { 1709 | content: "\f19d" 1710 | } 1711 | 1712 | .fa-yahoo:before { 1713 | content: "\f19e" 1714 | } 1715 | 1716 | .fa-google:before { 1717 | content: "\f1a0" 1718 | } 1719 | 1720 | .fa-reddit:before { 1721 | content: "\f1a1" 1722 | } 1723 | 1724 | .fa-reddit-square:before { 1725 | content: "\f1a2" 1726 | } 1727 | 1728 | .fa-stumbleupon-circle:before { 1729 | content: "\f1a3" 1730 | } 1731 | 1732 | .fa-stumbleupon:before { 1733 | content: "\f1a4" 1734 | } 1735 | 1736 | .fa-delicious:before { 1737 | content: "\f1a5" 1738 | } 1739 | 1740 | .fa-digg:before { 1741 | content: "\f1a6" 1742 | } 1743 | 1744 | .fa-pied-piper-pp:before { 1745 | content: "\f1a7" 1746 | } 1747 | 1748 | .fa-pied-piper-alt:before { 1749 | content: "\f1a8" 1750 | } 1751 | 1752 | .fa-drupal:before { 1753 | content: "\f1a9" 1754 | } 1755 | 1756 | .fa-joomla:before { 1757 | content: "\f1aa" 1758 | } 1759 | 1760 | .fa-language:before { 1761 | content: "\f1ab" 1762 | } 1763 | 1764 | .fa-fax:before { 1765 | content: "\f1ac" 1766 | } 1767 | 1768 | .fa-building:before { 1769 | content: "\f1ad" 1770 | } 1771 | 1772 | .fa-child:before { 1773 | content: "\f1ae" 1774 | } 1775 | 1776 | .fa-paw:before { 1777 | content: "\f1b0" 1778 | } 1779 | 1780 | .fa-spoon:before { 1781 | content: "\f1b1" 1782 | } 1783 | 1784 | .fa-cube:before { 1785 | content: "\f1b2" 1786 | } 1787 | 1788 | .fa-cubes:before { 1789 | content: "\f1b3" 1790 | } 1791 | 1792 | .fa-behance:before { 1793 | content: "\f1b4" 1794 | } 1795 | 1796 | .fa-behance-square:before { 1797 | content: "\f1b5" 1798 | } 1799 | 1800 | .fa-steam:before { 1801 | content: "\f1b6" 1802 | } 1803 | 1804 | .fa-steam-square:before { 1805 | content: "\f1b7" 1806 | } 1807 | 1808 | .fa-recycle:before { 1809 | content: "\f1b8" 1810 | } 1811 | 1812 | .fa-automobile:before, .fa-car:before { 1813 | content: "\f1b9" 1814 | } 1815 | 1816 | .fa-cab:before, .fa-taxi:before { 1817 | content: "\f1ba" 1818 | } 1819 | 1820 | .fa-tree:before { 1821 | content: "\f1bb" 1822 | } 1823 | 1824 | .fa-spotify:before { 1825 | content: "\f1bc" 1826 | } 1827 | 1828 | .fa-deviantart:before { 1829 | content: "\f1bd" 1830 | } 1831 | 1832 | .fa-soundcloud:before { 1833 | content: "\f1be" 1834 | } 1835 | 1836 | .fa-database:before { 1837 | content: "\f1c0" 1838 | } 1839 | 1840 | .fa-file-pdf-o:before { 1841 | content: "\f1c1" 1842 | } 1843 | 1844 | .fa-file-word-o:before { 1845 | content: "\f1c2" 1846 | } 1847 | 1848 | .fa-file-excel-o:before { 1849 | content: "\f1c3" 1850 | } 1851 | 1852 | .fa-file-powerpoint-o:before { 1853 | content: "\f1c4" 1854 | } 1855 | 1856 | .fa-file-photo-o:before, .fa-file-picture-o:before, .fa-file-image-o:before { 1857 | content: "\f1c5" 1858 | } 1859 | 1860 | .fa-file-zip-o:before, .fa-file-archive-o:before { 1861 | content: "\f1c6" 1862 | } 1863 | 1864 | .fa-file-sound-o:before, .fa-file-audio-o:before { 1865 | content: "\f1c7" 1866 | } 1867 | 1868 | .fa-file-movie-o:before, .fa-file-video-o:before { 1869 | content: "\f1c8" 1870 | } 1871 | 1872 | .fa-file-code-o:before { 1873 | content: "\f1c9" 1874 | } 1875 | 1876 | .fa-vine:before { 1877 | content: "\f1ca" 1878 | } 1879 | 1880 | .fa-codepen:before { 1881 | content: "\f1cb" 1882 | } 1883 | 1884 | .fa-jsfiddle:before { 1885 | content: "\f1cc" 1886 | } 1887 | 1888 | .fa-life-bouy:before, .fa-life-buoy:before, .fa-life-saver:before, .fa-support:before, .fa-life-ring:before { 1889 | content: "\f1cd" 1890 | } 1891 | 1892 | .fa-circle-o-notch:before { 1893 | content: "\f1ce" 1894 | } 1895 | 1896 | .fa-ra:before, .fa-resistance:before, .fa-rebel:before { 1897 | content: "\f1d0" 1898 | } 1899 | 1900 | .fa-ge:before, .fa-empire:before { 1901 | content: "\f1d1" 1902 | } 1903 | 1904 | .fa-git-square:before { 1905 | content: "\f1d2" 1906 | } 1907 | 1908 | .fa-git:before { 1909 | content: "\f1d3" 1910 | } 1911 | 1912 | .fa-y-combinator-square:before, .fa-yc-square:before, .fa-hacker-news:before { 1913 | content: "\f1d4" 1914 | } 1915 | 1916 | .fa-tencent-weibo:before { 1917 | content: "\f1d5" 1918 | } 1919 | 1920 | .fa-qq:before { 1921 | content: "\f1d6" 1922 | } 1923 | 1924 | .fa-wechat:before, .fa-weixin:before { 1925 | content: "\f1d7" 1926 | } 1927 | 1928 | .fa-send:before, .fa-paper-plane:before { 1929 | content: "\f1d8" 1930 | } 1931 | 1932 | .fa-send-o:before, .fa-paper-plane-o:before { 1933 | content: "\f1d9" 1934 | } 1935 | 1936 | .fa-history:before { 1937 | content: "\f1da" 1938 | } 1939 | 1940 | .fa-circle-thin:before { 1941 | content: "\f1db" 1942 | } 1943 | 1944 | .fa-header:before { 1945 | content: "\f1dc" 1946 | } 1947 | 1948 | .fa-paragraph:before { 1949 | content: "\f1dd" 1950 | } 1951 | 1952 | .fa-sliders:before { 1953 | content: "\f1de" 1954 | } 1955 | 1956 | .fa-share-alt:before { 1957 | content: "\f1e0" 1958 | } 1959 | 1960 | .fa-share-alt-square:before { 1961 | content: "\f1e1" 1962 | } 1963 | 1964 | .fa-bomb:before { 1965 | content: "\f1e2" 1966 | } 1967 | 1968 | .fa-soccer-ball-o:before, .fa-futbol-o:before { 1969 | content: "\f1e3" 1970 | } 1971 | 1972 | .fa-tty:before { 1973 | content: "\f1e4" 1974 | } 1975 | 1976 | .fa-binoculars:before { 1977 | content: "\f1e5" 1978 | } 1979 | 1980 | .fa-plug:before { 1981 | content: "\f1e6" 1982 | } 1983 | 1984 | .fa-slideshare:before { 1985 | content: "\f1e7" 1986 | } 1987 | 1988 | .fa-twitch:before { 1989 | content: "\f1e8" 1990 | } 1991 | 1992 | .fa-yelp:before { 1993 | content: "\f1e9" 1994 | } 1995 | 1996 | .fa-newspaper-o:before { 1997 | content: "\f1ea" 1998 | } 1999 | 2000 | .fa-wifi:before { 2001 | content: "\f1eb" 2002 | } 2003 | 2004 | .fa-calculator:before { 2005 | content: "\f1ec" 2006 | } 2007 | 2008 | .fa-paypal:before { 2009 | content: "\f1ed" 2010 | } 2011 | 2012 | .fa-google-wallet:before { 2013 | content: "\f1ee" 2014 | } 2015 | 2016 | .fa-cc-visa:before { 2017 | content: "\f1f0" 2018 | } 2019 | 2020 | .fa-cc-mastercard:before { 2021 | content: "\f1f1" 2022 | } 2023 | 2024 | .fa-cc-discover:before { 2025 | content: "\f1f2" 2026 | } 2027 | 2028 | .fa-cc-amex:before { 2029 | content: "\f1f3" 2030 | } 2031 | 2032 | .fa-cc-paypal:before { 2033 | content: "\f1f4" 2034 | } 2035 | 2036 | .fa-cc-stripe:before { 2037 | content: "\f1f5" 2038 | } 2039 | 2040 | .fa-bell-slash:before { 2041 | content: "\f1f6" 2042 | } 2043 | 2044 | .fa-bell-slash-o:before { 2045 | content: "\f1f7" 2046 | } 2047 | 2048 | .fa-trash:before { 2049 | content: "\f1f8" 2050 | } 2051 | 2052 | .fa-copyright:before { 2053 | content: "\f1f9" 2054 | } 2055 | 2056 | .fa-at:before { 2057 | content: "\f1fa" 2058 | } 2059 | 2060 | .fa-eyedropper:before { 2061 | content: "\f1fb" 2062 | } 2063 | 2064 | .fa-paint-brush:before { 2065 | content: "\f1fc" 2066 | } 2067 | 2068 | .fa-birthday-cake:before { 2069 | content: "\f1fd" 2070 | } 2071 | 2072 | .fa-area-chart:before { 2073 | content: "\f1fe" 2074 | } 2075 | 2076 | .fa-pie-chart:before { 2077 | content: "\f200" 2078 | } 2079 | 2080 | .fa-line-chart:before { 2081 | content: "\f201" 2082 | } 2083 | 2084 | .fa-lastfm:before { 2085 | content: "\f202" 2086 | } 2087 | 2088 | .fa-lastfm-square:before { 2089 | content: "\f203" 2090 | } 2091 | 2092 | .fa-toggle-off:before { 2093 | content: "\f204" 2094 | } 2095 | 2096 | .fa-toggle-on:before { 2097 | content: "\f205" 2098 | } 2099 | 2100 | .fa-bicycle:before { 2101 | content: "\f206" 2102 | } 2103 | 2104 | .fa-bus:before { 2105 | content: "\f207" 2106 | } 2107 | 2108 | .fa-ioxhost:before { 2109 | content: "\f208" 2110 | } 2111 | 2112 | .fa-angellist:before { 2113 | content: "\f209" 2114 | } 2115 | 2116 | .fa-cc:before { 2117 | content: "\f20a" 2118 | } 2119 | 2120 | .fa-shekel:before, .fa-sheqel:before, .fa-ils:before { 2121 | content: "\f20b" 2122 | } 2123 | 2124 | .fa-meanpath:before { 2125 | content: "\f20c" 2126 | } 2127 | 2128 | .fa-buysellads:before { 2129 | content: "\f20d" 2130 | } 2131 | 2132 | .fa-connectdevelop:before { 2133 | content: "\f20e" 2134 | } 2135 | 2136 | .fa-dashcube:before { 2137 | content: "\f210" 2138 | } 2139 | 2140 | .fa-forumbee:before { 2141 | content: "\f211" 2142 | } 2143 | 2144 | .fa-leanpub:before { 2145 | content: "\f212" 2146 | } 2147 | 2148 | .fa-sellsy:before { 2149 | content: "\f213" 2150 | } 2151 | 2152 | .fa-shirtsinbulk:before { 2153 | content: "\f214" 2154 | } 2155 | 2156 | .fa-simplybuilt:before { 2157 | content: "\f215" 2158 | } 2159 | 2160 | .fa-skyatlas:before { 2161 | content: "\f216" 2162 | } 2163 | 2164 | .fa-cart-plus:before { 2165 | content: "\f217" 2166 | } 2167 | 2168 | .fa-cart-arrow-down:before { 2169 | content: "\f218" 2170 | } 2171 | 2172 | .fa-diamond:before { 2173 | content: "\f219" 2174 | } 2175 | 2176 | .fa-ship:before { 2177 | content: "\f21a" 2178 | } 2179 | 2180 | .fa-user-secret:before { 2181 | content: "\f21b" 2182 | } 2183 | 2184 | .fa-motorcycle:before { 2185 | content: "\f21c" 2186 | } 2187 | 2188 | .fa-street-view:before { 2189 | content: "\f21d" 2190 | } 2191 | 2192 | .fa-heartbeat:before { 2193 | content: "\f21e" 2194 | } 2195 | 2196 | .fa-venus:before { 2197 | content: "\f221" 2198 | } 2199 | 2200 | .fa-mars:before { 2201 | content: "\f222" 2202 | } 2203 | 2204 | .fa-mercury:before { 2205 | content: "\f223" 2206 | } 2207 | 2208 | .fa-intersex:before, .fa-transgender:before { 2209 | content: "\f224" 2210 | } 2211 | 2212 | .fa-transgender-alt:before { 2213 | content: "\f225" 2214 | } 2215 | 2216 | .fa-venus-double:before { 2217 | content: "\f226" 2218 | } 2219 | 2220 | .fa-mars-double:before { 2221 | content: "\f227" 2222 | } 2223 | 2224 | .fa-venus-mars:before { 2225 | content: "\f228" 2226 | } 2227 | 2228 | .fa-mars-stroke:before { 2229 | content: "\f229" 2230 | } 2231 | 2232 | .fa-mars-stroke-v:before { 2233 | content: "\f22a" 2234 | } 2235 | 2236 | .fa-mars-stroke-h:before { 2237 | content: "\f22b" 2238 | } 2239 | 2240 | .fa-neuter:before { 2241 | content: "\f22c" 2242 | } 2243 | 2244 | .fa-genderless:before { 2245 | content: "\f22d" 2246 | } 2247 | 2248 | .fa-facebook-official:before { 2249 | content: "\f230" 2250 | } 2251 | 2252 | .fa-pinterest-p:before { 2253 | content: "\f231" 2254 | } 2255 | 2256 | .fa-whatsapp:before { 2257 | content: "\f232" 2258 | } 2259 | 2260 | .fa-server:before { 2261 | content: "\f233" 2262 | } 2263 | 2264 | .fa-user-plus:before { 2265 | content: "\f234" 2266 | } 2267 | 2268 | .fa-user-times:before { 2269 | content: "\f235" 2270 | } 2271 | 2272 | .fa-hotel:before, .fa-bed:before { 2273 | content: "\f236" 2274 | } 2275 | 2276 | .fa-viacoin:before { 2277 | content: "\f237" 2278 | } 2279 | 2280 | .fa-train:before { 2281 | content: "\f238" 2282 | } 2283 | 2284 | .fa-subway:before { 2285 | content: "\f239" 2286 | } 2287 | 2288 | .fa-medium:before { 2289 | content: "\f23a" 2290 | } 2291 | 2292 | .fa-yc:before, .fa-y-combinator:before { 2293 | content: "\f23b" 2294 | } 2295 | 2296 | .fa-optin-monster:before { 2297 | content: "\f23c" 2298 | } 2299 | 2300 | .fa-opencart:before { 2301 | content: "\f23d" 2302 | } 2303 | 2304 | .fa-expeditedssl:before { 2305 | content: "\f23e" 2306 | } 2307 | 2308 | .fa-battery-4:before, .fa-battery:before, .fa-battery-full:before { 2309 | content: "\f240" 2310 | } 2311 | 2312 | .fa-battery-3:before, .fa-battery-three-quarters:before { 2313 | content: "\f241" 2314 | } 2315 | 2316 | .fa-battery-2:before, .fa-battery-half:before { 2317 | content: "\f242" 2318 | } 2319 | 2320 | .fa-battery-1:before, .fa-battery-quarter:before { 2321 | content: "\f243" 2322 | } 2323 | 2324 | .fa-battery-0:before, .fa-battery-empty:before { 2325 | content: "\f244" 2326 | } 2327 | 2328 | .fa-mouse-pointer:before { 2329 | content: "\f245" 2330 | } 2331 | 2332 | .fa-i-cursor:before { 2333 | content: "\f246" 2334 | } 2335 | 2336 | .fa-object-group:before { 2337 | content: "\f247" 2338 | } 2339 | 2340 | .fa-object-ungroup:before { 2341 | content: "\f248" 2342 | } 2343 | 2344 | .fa-sticky-note:before { 2345 | content: "\f249" 2346 | } 2347 | 2348 | .fa-sticky-note-o:before { 2349 | content: "\f24a" 2350 | } 2351 | 2352 | .fa-cc-jcb:before { 2353 | content: "\f24b" 2354 | } 2355 | 2356 | .fa-cc-diners-club:before { 2357 | content: "\f24c" 2358 | } 2359 | 2360 | .fa-clone:before { 2361 | content: "\f24d" 2362 | } 2363 | 2364 | .fa-balance-scale:before { 2365 | content: "\f24e" 2366 | } 2367 | 2368 | .fa-hourglass-o:before { 2369 | content: "\f250" 2370 | } 2371 | 2372 | .fa-hourglass-1:before, .fa-hourglass-start:before { 2373 | content: "\f251" 2374 | } 2375 | 2376 | .fa-hourglass-2:before, .fa-hourglass-half:before { 2377 | content: "\f252" 2378 | } 2379 | 2380 | .fa-hourglass-3:before, .fa-hourglass-end:before { 2381 | content: "\f253" 2382 | } 2383 | 2384 | .fa-hourglass:before { 2385 | content: "\f254" 2386 | } 2387 | 2388 | .fa-hand-grab-o:before, .fa-hand-rock-o:before { 2389 | content: "\f255" 2390 | } 2391 | 2392 | .fa-hand-stop-o:before, .fa-hand-paper-o:before { 2393 | content: "\f256" 2394 | } 2395 | 2396 | .fa-hand-scissors-o:before { 2397 | content: "\f257" 2398 | } 2399 | 2400 | .fa-hand-lizard-o:before { 2401 | content: "\f258" 2402 | } 2403 | 2404 | .fa-hand-spock-o:before { 2405 | content: "\f259" 2406 | } 2407 | 2408 | .fa-hand-pointer-o:before { 2409 | content: "\f25a" 2410 | } 2411 | 2412 | .fa-hand-peace-o:before { 2413 | content: "\f25b" 2414 | } 2415 | 2416 | .fa-trademark:before { 2417 | content: "\f25c" 2418 | } 2419 | 2420 | .fa-registered:before { 2421 | content: "\f25d" 2422 | } 2423 | 2424 | .fa-creative-commons:before { 2425 | content: "\f25e" 2426 | } 2427 | 2428 | .fa-gg:before { 2429 | content: "\f260" 2430 | } 2431 | 2432 | .fa-gg-circle:before { 2433 | content: "\f261" 2434 | } 2435 | 2436 | .fa-tripadvisor:before { 2437 | content: "\f262" 2438 | } 2439 | 2440 | .fa-odnoklassniki:before { 2441 | content: "\f263" 2442 | } 2443 | 2444 | .fa-odnoklassniki-square:before { 2445 | content: "\f264" 2446 | } 2447 | 2448 | .fa-get-pocket:before { 2449 | content: "\f265" 2450 | } 2451 | 2452 | .fa-wikipedia-w:before { 2453 | content: "\f266" 2454 | } 2455 | 2456 | .fa-safari:before { 2457 | content: "\f267" 2458 | } 2459 | 2460 | .fa-chrome:before { 2461 | content: "\f268" 2462 | } 2463 | 2464 | .fa-firefox:before { 2465 | content: "\f269" 2466 | } 2467 | 2468 | .fa-opera:before { 2469 | content: "\f26a" 2470 | } 2471 | 2472 | .fa-internet-explorer:before { 2473 | content: "\f26b" 2474 | } 2475 | 2476 | .fa-tv:before, .fa-television:before { 2477 | content: "\f26c" 2478 | } 2479 | 2480 | .fa-contao:before { 2481 | content: "\f26d" 2482 | } 2483 | 2484 | .fa-500px:before { 2485 | content: "\f26e" 2486 | } 2487 | 2488 | .fa-amazon:before { 2489 | content: "\f270" 2490 | } 2491 | 2492 | .fa-calendar-plus-o:before { 2493 | content: "\f271" 2494 | } 2495 | 2496 | .fa-calendar-minus-o:before { 2497 | content: "\f272" 2498 | } 2499 | 2500 | .fa-calendar-times-o:before { 2501 | content: "\f273" 2502 | } 2503 | 2504 | .fa-calendar-check-o:before { 2505 | content: "\f274" 2506 | } 2507 | 2508 | .fa-industry:before { 2509 | content: "\f275" 2510 | } 2511 | 2512 | .fa-map-pin:before { 2513 | content: "\f276" 2514 | } 2515 | 2516 | .fa-map-signs:before { 2517 | content: "\f277" 2518 | } 2519 | 2520 | .fa-map-o:before { 2521 | content: "\f278" 2522 | } 2523 | 2524 | .fa-map:before { 2525 | content: "\f279" 2526 | } 2527 | 2528 | .fa-commenting:before { 2529 | content: "\f27a" 2530 | } 2531 | 2532 | .fa-commenting-o:before { 2533 | content: "\f27b" 2534 | } 2535 | 2536 | .fa-houzz:before { 2537 | content: "\f27c" 2538 | } 2539 | 2540 | .fa-vimeo:before { 2541 | content: "\f27d" 2542 | } 2543 | 2544 | .fa-black-tie:before { 2545 | content: "\f27e" 2546 | } 2547 | 2548 | .fa-fonticons:before { 2549 | content: "\f280" 2550 | } 2551 | 2552 | .fa-reddit-alien:before { 2553 | content: "\f281" 2554 | } 2555 | 2556 | .fa-edge:before { 2557 | content: "\f282" 2558 | } 2559 | 2560 | .fa-credit-card-alt:before { 2561 | content: "\f283" 2562 | } 2563 | 2564 | .fa-codiepie:before { 2565 | content: "\f284" 2566 | } 2567 | 2568 | .fa-modx:before { 2569 | content: "\f285" 2570 | } 2571 | 2572 | .fa-fort-awesome:before { 2573 | content: "\f286" 2574 | } 2575 | 2576 | .fa-usb:before { 2577 | content: "\f287" 2578 | } 2579 | 2580 | .fa-product-hunt:before { 2581 | content: "\f288" 2582 | } 2583 | 2584 | .fa-mixcloud:before { 2585 | content: "\f289" 2586 | } 2587 | 2588 | .fa-scribd:before { 2589 | content: "\f28a" 2590 | } 2591 | 2592 | .fa-pause-circle:before { 2593 | content: "\f28b" 2594 | } 2595 | 2596 | .fa-pause-circle-o:before { 2597 | content: "\f28c" 2598 | } 2599 | 2600 | .fa-stop-circle:before { 2601 | content: "\f28d" 2602 | } 2603 | 2604 | .fa-stop-circle-o:before { 2605 | content: "\f28e" 2606 | } 2607 | 2608 | .fa-shopping-bag:before { 2609 | content: "\f290" 2610 | } 2611 | 2612 | .fa-shopping-basket:before { 2613 | content: "\f291" 2614 | } 2615 | 2616 | .fa-hashtag:before { 2617 | content: "\f292" 2618 | } 2619 | 2620 | .fa-bluetooth:before { 2621 | content: "\f293" 2622 | } 2623 | 2624 | .fa-bluetooth-b:before { 2625 | content: "\f294" 2626 | } 2627 | 2628 | .fa-percent:before { 2629 | content: "\f295" 2630 | } 2631 | 2632 | .fa-gitlab:before { 2633 | content: "\f296" 2634 | } 2635 | 2636 | .fa-wpbeginner:before { 2637 | content: "\f297" 2638 | } 2639 | 2640 | .fa-wpforms:before { 2641 | content: "\f298" 2642 | } 2643 | 2644 | .fa-envira:before { 2645 | content: "\f299" 2646 | } 2647 | 2648 | .fa-universal-access:before { 2649 | content: "\f29a" 2650 | } 2651 | 2652 | .fa-wheelchair-alt:before { 2653 | content: "\f29b" 2654 | } 2655 | 2656 | .fa-question-circle-o:before { 2657 | content: "\f29c" 2658 | } 2659 | 2660 | .fa-blind:before { 2661 | content: "\f29d" 2662 | } 2663 | 2664 | .fa-audio-description:before { 2665 | content: "\f29e" 2666 | } 2667 | 2668 | .fa-volume-control-phone:before { 2669 | content: "\f2a0" 2670 | } 2671 | 2672 | .fa-braille:before { 2673 | content: "\f2a1" 2674 | } 2675 | 2676 | .fa-assistive-listening-systems:before { 2677 | content: "\f2a2" 2678 | } 2679 | 2680 | .fa-asl-interpreting:before, .fa-american-sign-language-interpreting:before { 2681 | content: "\f2a3" 2682 | } 2683 | 2684 | .fa-deafness:before, .fa-hard-of-hearing:before, .fa-deaf:before { 2685 | content: "\f2a4" 2686 | } 2687 | 2688 | .fa-glide:before { 2689 | content: "\f2a5" 2690 | } 2691 | 2692 | .fa-glide-g:before { 2693 | content: "\f2a6" 2694 | } 2695 | 2696 | .fa-signing:before, .fa-sign-language:before { 2697 | content: "\f2a7" 2698 | } 2699 | 2700 | .fa-low-vision:before { 2701 | content: "\f2a8" 2702 | } 2703 | 2704 | .fa-viadeo:before { 2705 | content: "\f2a9" 2706 | } 2707 | 2708 | .fa-viadeo-square:before { 2709 | content: "\f2aa" 2710 | } 2711 | 2712 | .fa-snapchat:before { 2713 | content: "\f2ab" 2714 | } 2715 | 2716 | .fa-snapchat-ghost:before { 2717 | content: "\f2ac" 2718 | } 2719 | 2720 | .fa-snapchat-square:before { 2721 | content: "\f2ad" 2722 | } 2723 | 2724 | .fa-pied-piper:before { 2725 | content: "\f2ae" 2726 | } 2727 | 2728 | .fa-first-order:before { 2729 | content: "\f2b0" 2730 | } 2731 | 2732 | .fa-yoast:before { 2733 | content: "\f2b1" 2734 | } 2735 | 2736 | .fa-themeisle:before { 2737 | content: "\f2b2" 2738 | } 2739 | 2740 | .fa-google-plus-circle:before, .fa-google-plus-official:before { 2741 | content: "\f2b3" 2742 | } 2743 | 2744 | .fa-fa:before, .fa-font-awesome:before { 2745 | content: "\f2b4" 2746 | } 2747 | 2748 | .fa-handshake-o:before { 2749 | content: "\f2b5" 2750 | } 2751 | 2752 | .fa-envelope-open:before { 2753 | content: "\f2b6" 2754 | } 2755 | 2756 | .fa-envelope-open-o:before { 2757 | content: "\f2b7" 2758 | } 2759 | 2760 | .fa-linode:before { 2761 | content: "\f2b8" 2762 | } 2763 | 2764 | .fa-address-book:before { 2765 | content: "\f2b9" 2766 | } 2767 | 2768 | .fa-address-book-o:before { 2769 | content: "\f2ba" 2770 | } 2771 | 2772 | .fa-vcard:before, .fa-address-card:before { 2773 | content: "\f2bb" 2774 | } 2775 | 2776 | .fa-vcard-o:before, .fa-address-card-o:before { 2777 | content: "\f2bc" 2778 | } 2779 | 2780 | .fa-user-circle:before { 2781 | content: "\f2bd" 2782 | } 2783 | 2784 | .fa-user-circle-o:before { 2785 | content: "\f2be" 2786 | } 2787 | 2788 | .fa-user-o:before { 2789 | content: "\f2c0" 2790 | } 2791 | 2792 | .fa-id-badge:before { 2793 | content: "\f2c1" 2794 | } 2795 | 2796 | .fa-drivers-license:before, .fa-id-card:before { 2797 | content: "\f2c2" 2798 | } 2799 | 2800 | .fa-drivers-license-o:before, .fa-id-card-o:before { 2801 | content: "\f2c3" 2802 | } 2803 | 2804 | .fa-quora:before { 2805 | content: "\f2c4" 2806 | } 2807 | 2808 | .fa-free-code-camp:before { 2809 | content: "\f2c5" 2810 | } 2811 | 2812 | .fa-telegram:before { 2813 | content: "\f2c6" 2814 | } 2815 | 2816 | .fa-thermometer-4:before, .fa-thermometer:before, .fa-thermometer-full:before { 2817 | content: "\f2c7" 2818 | } 2819 | 2820 | .fa-thermometer-3:before, .fa-thermometer-three-quarters:before { 2821 | content: "\f2c8" 2822 | } 2823 | 2824 | .fa-thermometer-2:before, .fa-thermometer-half:before { 2825 | content: "\f2c9" 2826 | } 2827 | 2828 | .fa-thermometer-1:before, .fa-thermometer-quarter:before { 2829 | content: "\f2ca" 2830 | } 2831 | 2832 | .fa-thermometer-0:before, .fa-thermometer-empty:before { 2833 | content: "\f2cb" 2834 | } 2835 | 2836 | .fa-shower:before { 2837 | content: "\f2cc" 2838 | } 2839 | 2840 | .fa-bathtub:before, .fa-s15:before, .fa-bath:before { 2841 | content: "\f2cd" 2842 | } 2843 | 2844 | .fa-podcast:before { 2845 | content: "\f2ce" 2846 | } 2847 | 2848 | .fa-window-maximize:before { 2849 | content: "\f2d0" 2850 | } 2851 | 2852 | .fa-window-minimize:before { 2853 | content: "\f2d1" 2854 | } 2855 | 2856 | .fa-window-restore:before { 2857 | content: "\f2d2" 2858 | } 2859 | 2860 | .fa-times-rectangle:before, .fa-window-close:before { 2861 | content: "\f2d3" 2862 | } 2863 | 2864 | .fa-times-rectangle-o:before, .fa-window-close-o:before { 2865 | content: "\f2d4" 2866 | } 2867 | 2868 | .fa-bandcamp:before { 2869 | content: "\f2d5" 2870 | } 2871 | 2872 | .fa-grav:before { 2873 | content: "\f2d6" 2874 | } 2875 | 2876 | .fa-etsy:before { 2877 | content: "\f2d7" 2878 | } 2879 | 2880 | .fa-imdb:before { 2881 | content: "\f2d8" 2882 | } 2883 | 2884 | .fa-ravelry:before { 2885 | content: "\f2d9" 2886 | } 2887 | 2888 | .fa-eercast:before { 2889 | content: "\f2da" 2890 | } 2891 | 2892 | .fa-microchip:before { 2893 | content: "\f2db" 2894 | } 2895 | 2896 | .fa-snowflake-o:before { 2897 | content: "\f2dc" 2898 | } 2899 | 2900 | .fa-superpowers:before { 2901 | content: "\f2dd" 2902 | } 2903 | 2904 | .fa-wpexplorer:before { 2905 | content: "\f2de" 2906 | } 2907 | 2908 | .fa-meetup:before { 2909 | content: "\f2e0" 2910 | } 2911 | 2912 | .sr-only { 2913 | position: absolute; 2914 | width: 1px; 2915 | height: 1px; 2916 | padding: 0; 2917 | margin: -1px; 2918 | overflow: hidden; 2919 | clip: rect(0, 0, 0, 0); 2920 | border: 0 2921 | } 2922 | 2923 | .sr-only-focusable:active, .sr-only-focusable:focus { 2924 | position: static; 2925 | width: auto; 2926 | height: auto; 2927 | margin: 0; 2928 | overflow: visible; 2929 | clip: auto 2930 | } 2931 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/fonts/material-icons.css: -------------------------------------------------------------------------------- 1 | /*! 2 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not 3 | * use this file except in compliance with the License. You may obtain a copy 4 | * of the License at: 5 | * 6 | * http://www.apache.org/licenses/LICENSE-2.0 7 | * 8 | * UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, SOFTWARE 9 | * DISTRIBUTED UNDER THE LICENSE IS DISTRIBUTED ON AN "AS IS" BASIS, 10 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 11 | * SEE THE LICENSE FOR THE SPECIFIC LANGUAGE GOVERNING PERMISSIONS AND 12 | * LIMITATIONS UNDER THE LICENSE. 13 | */ 14 | 15 | @font-face { 16 | font-family: "Material Icons"; 17 | font-style: normal; 18 | font-weight: 400; 19 | src: local("Material Icons"), 20 | local("MaterialIcons-Regular"), 21 | url("specimen/MaterialIcons-Regular.woff2") format("woff2"), 22 | url("specimen/MaterialIcons-Regular.woff") format("woff"), 23 | url("specimen/MaterialIcons-Regular.ttf") format("truetype"); 24 | } 25 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/fonts/specimen/FontAwesome.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/fonts/specimen/FontAwesome.ttf -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/fonts/specimen/FontAwesome.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/fonts/specimen/FontAwesome.woff -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/fonts/specimen/FontAwesome.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/fonts/specimen/FontAwesome.woff2 -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/fonts/specimen/MaterialIcons-Regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/fonts/specimen/MaterialIcons-Regular.ttf -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/fonts/specimen/MaterialIcons-Regular.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/fonts/specimen/MaterialIcons-Regular.woff -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/fonts/specimen/MaterialIcons-Regular.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/comwes/mkpdfs-mkdocs-plugin/6b692de17642431087a8c5963023f7816c04c991/mkpdfs_mkdocs/design/fonts/specimen/MaterialIcons-Regular.woff2 -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "mkpdfs-design", 3 | "version": "1.0.0", 4 | "description": "The default mkpdfs design to use when generating the pdf report. This style will only be used for the pdf, not to be included in the webversion as it can conflict with other themes.", 5 | "scripts": { 6 | "test": "echo \"Error: no test specified\" && exit 1", 7 | "build-css": "node-sass report.scss report.css" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/comwes/mkpdfs-mkdocs-plugin.git" 12 | }, 13 | "keywords": [ 14 | "mkdocs", 15 | "documentation", 16 | "pdf", 17 | "markdown", 18 | "plugin" 19 | ], 20 | "devDependencies": { 21 | "material-design-color": "^2.3.2", 22 | "material-shadows": "^3.0.1", 23 | "modularscale-sass": "^3.0.8", 24 | "node-sass": "^6.0.1", 25 | "trim-newlines": ">=3.0.1" 26 | }, 27 | "author": { 28 | "name": "Comwes, Gerry Ntabuhashe", 29 | "email": "contact@comwes.eu, gnt@comwes.eu", 30 | "url": "https://comwes.eu, https://mkpdfs.comwes.eu" 31 | }, 32 | "license": "MIT", 33 | "bugs": { 34 | "url": "https://github.com/comwes/mkpdfs-mkdocs-plugin/issues" 35 | }, 36 | "homepage": "https://github.com/comwes/mkpdfs-mkdocs-plugin#readme" 37 | } 38 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/report.scss: -------------------------------------------------------------------------------- 1 | @import "https://fonts.googleapis.com/icon?family=Material+Icons"; 2 | 3 | @import "stylesheets/extensions.scss"; 4 | 5 | $bgColor: #2196f3; 6 | $bgTextColor: #fff; 7 | 8 | 9 | @font-face { 10 | font-family: Fira Sans; 11 | font-weight: 400; 12 | src: url(FiraSans-Regular.otf); 13 | } 14 | 15 | 16 | @font-face { 17 | font-family: Fira Sans; 18 | font-style: italic; 19 | font-weight: 400; 20 | src: url(FiraSans-Italic.otf); 21 | } 22 | 23 | 24 | @font-face { 25 | font-family: Fira Sans; 26 | font-weight: 300; 27 | src: url(FiraSans-Light.otf); 28 | } 29 | 30 | 31 | @font-face { 32 | font-family: Fira Sans; 33 | font-style: italic; 34 | font-weight: 300; 35 | src: url(FiraSans-LightItalic.otf); 36 | } 37 | 38 | 39 | @font-face { 40 | font-family: Fira Sans; 41 | font-weight: bold; 42 | src: url(FiraSans-Bold.otf); 43 | } 44 | 45 | 46 | @page { 47 | @top-left { 48 | background: $bgColor; 49 | content: counter(page); 50 | height: 1cm; 51 | color: $bgTextColor; 52 | text-align: center; 53 | width: 1cm; 54 | } 55 | 56 | @top-center { 57 | background: $bgColor; 58 | content: ''; 59 | display: block; 60 | height: .05cm; 61 | opacity: .5; 62 | width: 100%; 63 | } 64 | 65 | @top-right { 66 | content: string(heading); 67 | font-size: 9pt; 68 | height: 1cm; 69 | vertical-align: middle; 70 | width: 100%; 71 | } 72 | 73 | @bottom-right { 74 | content: string(copyright); 75 | font-size: 9pt; 76 | height: 1cm; 77 | vertical-align: middle; 78 | width: 100%; 79 | } 80 | } 81 | 82 | 83 | @page :blank { 84 | @top-left { 85 | background: none; 86 | content: ''; 87 | } 88 | 89 | @top-center { 90 | content: none; 91 | } 92 | 93 | @top-right { 94 | content: none; 95 | } 96 | 97 | @bottom-right { 98 | content: none; 99 | } 100 | } 101 | 102 | 103 | @page no-chapter { 104 | @top-left { 105 | background: none; 106 | content: none; 107 | } 108 | 109 | @top-center { 110 | content: none; 111 | } 112 | 113 | @top-right { 114 | content: none; 115 | } 116 | 117 | @bottom-right { 118 | content: none; 119 | } 120 | } 121 | 122 | @page chapter { 123 | margin: 0; 124 | padding: 0; 125 | @top-left { 126 | content: none; 127 | } 128 | @top-center { 129 | content: none; 130 | } 131 | @top-right { 132 | content: none; 133 | } 134 | } 135 | 136 | 137 | @page :first { 138 | background: url(cover.jpg) no-repeat center; 139 | background-size: cover; 140 | margin: 0; 141 | counter-reset: page -1; 142 | } 143 | 144 | 145 | html { 146 | body { 147 | article.chapter { 148 | align-items: center; 149 | display: flex; 150 | flex-direction: row; 151 | height: 297mm; 152 | justify-content: flex-end; 153 | page: chapter; 154 | h1.section_title{ 155 | background-color: $bgColor; 156 | padding: 1cm; 157 | width: 60%; 158 | text-align: center; 159 | color: $bgTextColor; 160 | font-size: 30pt; 161 | } 162 | } 163 | } 164 | article#doc-cover h1#doc-title { 165 | color: $bgColor; 166 | font-size: 38pt; 167 | margin: 5cm 2cm 0 2cm; 168 | page: no-chapter; 169 | width: 100%; 170 | } 171 | body article#doc-cover { 172 | break-after: right; 173 | align-content: space-between; 174 | display: flex; 175 | flex-wrap: wrap; 176 | margin: 0; 177 | height: 297mm; 178 | address { 179 | background: $bgColor; 180 | flex: 1; 181 | color: $bgTextColor; 182 | margin: 0 -2cm; 183 | padding: 1cm 0; 184 | font-style: normal; 185 | white-space: pre-wrap; 186 | &:last-of-type { 187 | padding-right: 3cm; 188 | text-align: right; 189 | } 190 | &:first-of-type { 191 | padding-left: 3cm; 192 | } 193 | p{ 194 | margin: 0; 195 | padding: 0; 196 | } 197 | p#copyright { 198 | string-set: copyright content(); 199 | } 200 | } 201 | } 202 | color: #393939; 203 | font-family: Fira Sans, helvetica, arial; 204 | font-size: 11pt; 205 | font-weight: 300; 206 | line-height: 1.5; 207 | } 208 | 209 | 210 | .html iframe, html img, .html svg { 211 | max-width: 100%; 212 | margin-top: 5px; 213 | } 214 | 215 | html body { 216 | h1 { 217 | color: $bgColor; 218 | string-set: heading content(); 219 | } 220 | h2, h3, h4 { 221 | color: black; 222 | font-weight: 400; 223 | } 224 | h2 { 225 | font-size: 20pt; 226 | } 227 | h3 { 228 | font-weight: 300; 229 | font-size: 15pt; 230 | } 231 | h4 { 232 | font-size: 13pt; 233 | } 234 | article { 235 | break-before: always; 236 | video { 237 | source::before { 238 | content: attr(src); 239 | } 240 | &[src]::before { 241 | content: attr(data-title) " https://mkpdfs.comwes.eu" attr(src); 242 | } 243 | } 244 | } 245 | } 246 | 247 | div.admonition { 248 | break-inside: avoid; 249 | } 250 | 251 | h2, h3, h4, h5 { 252 | margin-bottom: 0.1em; 253 | } 254 | 255 | html body article { 256 | a { 257 | color: $bgColor; 258 | text-decoration: none; 259 | &.external-link::after { 260 | content: " (" attr(href) ")"; 261 | font-style: italic; 262 | } 263 | 264 | } 265 | table { 266 | border-spacing: 0; 267 | border-collapse: collapse; 268 | tr { 269 | border-bottom: 1px solid #888; 270 | td { 271 | padding: 4px 7px; 272 | } 273 | } 274 | } 275 | &#contents { 276 | break-before: right; 277 | break-after: left; 278 | page: no-chapter; 279 | h2 { 280 | font-size: 20pt; 281 | font-weight: 400; 282 | margin-bottom: 3cm; 283 | } 284 | h3 { 285 | font-weight: 500; 286 | margin: 3em 0 1em; 287 | &::before { 288 | background: $bgColor; 289 | content: ''; 290 | display: block; 291 | height: .08cm; 292 | margin-bottom: .25cm; 293 | width: 2cm; 294 | } 295 | } 296 | ul { 297 | list-style: none; 298 | padding-left: .5cm; 299 | li { 300 | border-top: .25pt solid #c1c1c1; 301 | margin: .15cm 0; 302 | padding-top: .15cm; 303 | &::before { 304 | color: $bgColor; 305 | content: '• '; 306 | font-size: 40pt; 307 | line-height: 16pt; 308 | vertical-align: bottom; 309 | } 310 | a { 311 | color: inherit; 312 | text-decoration: inherit; 313 | } 314 | } 315 | } 316 | > ul { 317 | list-style: none; 318 | padding-left: 0; 319 | } 320 | div h4 a::after, ul li a::after { 321 | color: $bgColor; 322 | content: target-counter(attr(href), page); 323 | float: right; 324 | } 325 | div h4 { 326 | margin: .15cm 0; 327 | padding-top: 0; 328 | padding-bottom: 0; 329 | a { 330 | color: inherit; 331 | } 332 | } 333 | } 334 | p { 335 | text-align: justify; 336 | } 337 | } 338 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/_config.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Variables: typography 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Modular typographic scale 28 | $ms-base: px2rem(20px); 29 | $ms-ratio: $major-third; 30 | 31 | // ---------------------------------------------------------------------------- 32 | // Variables: breakpoints 33 | // ---------------------------------------------------------------------------- 34 | 35 | // stylelint-disable unit-whitelist 36 | 37 | // Device-specific breakpoints 38 | $break-devices: ( 39 | mobile: ( 40 | portrait: px2em(220px) px2em(479px), 41 | landscape: px2em(480px) px2em(719px) 42 | ), 43 | tablet: ( 44 | portrait: px2em(720px) px2em(959px), 45 | landscape: px2em(960px) px2em(1219px) 46 | ), 47 | screen: ( 48 | small: px2em(1220px) px2em(1599px), 49 | medium: px2em(1600px) px2em(1999px), 50 | large: px2em(2000px) 51 | ) 52 | ); 53 | 54 | // stylelint-enable unit-whitelist 55 | 56 | // ---------------------------------------------------------------------------- 57 | // Variables: base colors 58 | // ---------------------------------------------------------------------------- 59 | 60 | // Primary and accent colors 61 | $md-color-primary: $clr-indigo-500 !default; 62 | $md-color-accent: $clr-indigo-a200 !default; 63 | 64 | // Shades of black 65 | $md-color-black: hsla(0, 0%, 0%, 0.87) !default; 66 | $md-color-black--light: hsla(0, 0%, 0%, 0.54) !default; 67 | $md-color-black--lighter: hsla(0, 0%, 0%, 0.26) !default; 68 | $md-color-black--lightest: hsla(0, 0%, 0%, 0.07) !default; 69 | $md-color-black--transparent: hsla(0, 0%, 0%, 0) !default; 70 | 71 | // Shades of white 72 | $md-color-white: hsla(0, 0%, 100%, 1) !default; 73 | $md-color-white--light: hsla(0, 0%, 100%, 0.7) !default; 74 | $md-color-white--lighter: hsla(0, 0%, 100%, 0.3) !default; 75 | $md-color-white--lightest: hsla(0, 0%, 100%, 0.12) !default; 76 | $md-color-white--transparent: hsla(0, 0%, 100%, 0) !default; 77 | 78 | // ---------------------------------------------------------------------------- 79 | // Variables: sizing and spacing 80 | // ---------------------------------------------------------------------------- 81 | 82 | // Icons 83 | $md-icon-size: $ms-base * 1.5; 84 | $md-icon-padding: $ms-base * 0.5; 85 | $md-icon-margin: $ms-base * 0.25; 86 | 87 | // Code blocks 88 | $md-code-background: hsla(0, 0%, 92.5%, 0.5); 89 | $md-code-color: #37474F; 90 | 91 | // Keystrokes 92 | $md-keyboard-background: #FCFCFC; 93 | $md-keyboard-color: #555555; 94 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/_extensions.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Dependencies 25 | // ---------------------------------------------------------------------------- 26 | 27 | @import "../node_modules/modularscale-sass/stylesheets/modularscale"; 28 | @import "../node_modules/material-design-color/material-color"; 29 | @import "../node_modules/material-shadows/material-shadows"; 30 | 31 | @import "helpers/break"; 32 | @import "helpers/px2em"; 33 | 34 | @import "config"; 35 | 36 | @import "base/icons"; 37 | 38 | @import "extensions/admonition"; 39 | @import "extensions/codehilite"; 40 | @import "extensions/footnotes"; 41 | 42 | @import "extensions/pymdown/arithmatex"; 43 | @import "extensions/pymdown/critic"; 44 | @import "extensions/pymdown/details"; 45 | @import "extensions/pymdown/emoji"; 46 | @import "extensions/pymdown/inlinehilite"; 47 | @import "extensions/pymdown/superfences"; 48 | @import "extensions/pymdown/tasklist"; 49 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/base/.stylelintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../../../.stylelintrc", 3 | "rules": { 4 | "font-weight-notation": null, 5 | "property-no-vendor-prefix": null 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/base/_icons.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // stylelint-disable font-family-no-missing-generic-family-keyword 24 | 25 | // ---------------------------------------------------------------------------- 26 | // Rules 27 | // ---------------------------------------------------------------------------- 28 | 29 | // Icon placeholders 30 | %md-icon { 31 | font-family: "Material Icons"; 32 | font-style: normal; 33 | font-variant: normal; 34 | font-weight: normal; 35 | line-height: 1; 36 | text-transform: none; 37 | white-space: nowrap; 38 | speak: none; 39 | word-wrap: normal; 40 | direction: ltr; 41 | 42 | // Icon rendered as button 43 | &__button { 44 | display: inline-block; 45 | margin: $md-icon-margin; 46 | padding: $md-icon-padding; 47 | font-size: $md-icon-size; 48 | cursor: pointer; 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/_admonition.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2020 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Variables 25 | // ---------------------------------------------------------------------------- 26 | 27 | /// 28 | /// Admonition flavours 29 | /// 30 | $admonitions: ( 31 | note: pencil $clr-blue-a200, 32 | abstract summary tldr: text-subject $clr-light-blue-a400, 33 | info todo: information $clr-cyan-a700, 34 | tip hint important: fire $clr-teal-a700, 35 | success check done: check-circle $clr-green-a700, 36 | question help faq: help-circle $clr-light-green-a700, 37 | warning caution attention: alert $clr-orange-a400, 38 | failure fail missing: close-circle $clr-red-a200, 39 | danger error: flash-circle $clr-red-a400, 40 | bug: bug $clr-pink-a400, 41 | example: format-list-numbered $clr-deep-purple-a400, 42 | quote cite: format-quote-close $clr-grey 43 | ) !default; 44 | 45 | // ---------------------------------------------------------------------------- 46 | // Rules: layout 47 | // ---------------------------------------------------------------------------- 48 | 49 | // Icon definitions 50 | :root { 51 | @each $names, $props in $admonitions { 52 | $name: nth($names, 1); 53 | $icon: nth($props, 1); 54 | 55 | // Inline icon through string-replace-loader in webpack 56 | --md-admonition-icon--#{$name}: svg-load("@mdi/svg/svg/#{$icon}.svg"); 57 | } 58 | } 59 | 60 | // ---------------------------------------------------------------------------- 61 | 62 | // Scoped in typesetted content to match specificity of regular content 63 | .md-typeset { 64 | 65 | // Admonition extension 66 | .admonition { 67 | margin: 1.5625em 0; 68 | padding: 0 px2rem(12px); 69 | overflow: hidden; 70 | font-size: ms(-1); 71 | page-break-inside: avoid; 72 | border-left: px2rem(4px) solid $clr-blue-a200; 73 | border-radius: px2rem(2px); 74 | box-shadow: 75 | 0 px2rem(4px) px2rem(10px) hsla(0, 0%, 0%, 0.05), 76 | 0 0 px2rem(1px) hsla(0, 0%, 0%, 0.1); 77 | 78 | // Adjust for right-to-left languages 79 | [dir="rtl"] & { 80 | border-right: px2rem(4px) solid $clr-blue-a200; 81 | border-left: none; 82 | } 83 | 84 | // Hack: omit rendering errors for print 85 | @media print { 86 | box-shadow: none; 87 | } 88 | 89 | // Adjust spacing on last element 90 | html & > :last-child { 91 | margin-bottom: px2rem(12px); 92 | } 93 | 94 | // Adjust margin for nested admonition blocks 95 | .admonition { 96 | margin: 1em 0; 97 | } 98 | 99 | // Wrapper for scrolling on overflow 100 | .md-typeset__scrollwrap { 101 | margin: 1em px2rem(-12px); 102 | } 103 | 104 | // Data table wrapper, in case JavaScript is available 105 | .md-typeset__table { 106 | padding: 0 px2rem(12px); 107 | } 108 | } 109 | 110 | // Admonition title 111 | .admonition-title { 112 | position: relative; 113 | margin: 0 px2rem(-12px); 114 | padding: px2rem(8px) px2rem(12px) px2rem(8px) px2rem(40px); 115 | font-weight: 700; 116 | background-color: transparentize($clr-blue-a200, 0.9); 117 | 118 | // Adjust for right-to-left languages 119 | [dir="rtl"] & { 120 | padding: px2rem(8px) px2rem(40px) px2rem(8px) px2rem(12px); 121 | } 122 | 123 | // Reset spacing, if title is the only element 124 | html &:last-child { 125 | margin-bottom: 0; 126 | } 127 | 128 | // Icon 129 | &::before { 130 | position: absolute; 131 | left: px2rem(12px); 132 | width: px2rem(20px); 133 | height: px2rem(20px); 134 | background-color: $clr-blue-a200; 135 | mask-image: var(--md-admonition-icon--note); 136 | content: ""; 137 | 138 | // Adjust for right-to-left languages 139 | [dir="rtl"] & { 140 | right: px2rem(12px); 141 | left: initial; 142 | } 143 | } 144 | 145 | // Reset code inside Admonition titles 146 | code { 147 | margin: initial; 148 | padding: initial; 149 | color: currentColor; 150 | background-color: transparent; 151 | border-radius: initial; 152 | box-shadow: none; 153 | } 154 | } 155 | } 156 | 157 | // ---------------------------------------------------------------------------- 158 | // Rules: flavours 159 | // ---------------------------------------------------------------------------- 160 | 161 | @each $names, $props in $admonitions { 162 | $name: nth($names, 1); 163 | $tint: nth($props, 2); 164 | 165 | // Define base class 166 | .md-typeset .admonition.#{$name} { 167 | border-color: $tint; 168 | } 169 | 170 | // Define base class 171 | .md-typeset .#{$name} > .admonition-title { 172 | background-color: transparentize($tint, 0.9); 173 | 174 | // Icon 175 | &::before { 176 | background-color: $tint; 177 | mask-image: var(--md-admonition-icon--#{$name}); 178 | } 179 | } 180 | 181 | // Define synonyms for base class 182 | @if length($names) > 1 { 183 | @for $n from 2 through length($names) { 184 | .#{nth($names, $n)} { 185 | @extend .#{$name}; 186 | } 187 | } 188 | } 189 | } -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/_codehilite.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Variables 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Operators 28 | $codehilite-operator: inherit; 29 | $codehilite-operator-word: inherit; 30 | 31 | // Generics 32 | $codehilite-generic-emph: #000000; 33 | $codehilite-generic-error: #AA0000; 34 | $codehilite-generic-heading: #999999; 35 | $codehilite-generic-output: #888888; 36 | $codehilite-generic-prompt: #555555; 37 | $codehilite-generic-strong: inherit; 38 | $codehilite-generic-subheading: #AAAAAA; 39 | $codehilite-generic-traceback: #AA0000; 40 | 41 | // Diffs 42 | $codehilite-diff-deleted: #FFDDDD; 43 | $codehilite-diff-inserted: #DDFFDD; 44 | 45 | // Keywords 46 | $codehilite-keyword: #3B78E7; 47 | $codehilite-keyword-constant: #A71D5D; 48 | $codehilite-keyword-declaration: #3B78E7; 49 | $codehilite-keyword-namespace: #3B78E7; 50 | $codehilite-keyword-pseudo: #A71D5D; 51 | $codehilite-keyword-reserved: #3E61A2; 52 | $codehilite-keyword-type: #3E61A2; 53 | 54 | // Comments 55 | $codehilite-comment: #999999; 56 | $codehilite-comment-multiline: #999999; 57 | $codehilite-comment-preproc: #666666; 58 | $codehilite-comment-single: #999999; 59 | $codehilite-comment-shebang: #999999; 60 | $codehilite-comment-special: #999999; 61 | 62 | // Names 63 | $codehilite-name-attribute: #C2185B; 64 | $codehilite-name-builtin: #C2185B; 65 | $codehilite-name-builtin-pseudo: #3E61A2; 66 | $codehilite-name-class: #C2185B; 67 | $codehilite-name-constant: #3E61A2; 68 | $codehilite-name-decorator: #666666; 69 | $codehilite-name-entity: #666666; 70 | $codehilite-name-exception: #C2185B; 71 | $codehilite-name-function: #C2185B; 72 | $codehilite-name-label: #3B5179; 73 | $codehilite-name-namespace: #EC407A; 74 | $codehilite-name-tag: #3B78E7; 75 | $codehilite-name-variable: #3E61A2; 76 | $codehilite-name-variable-class: #3E61A2; 77 | $codehilite-name-variable-instance: #3E61A2; 78 | $codehilite-name-variable-global: #3E61A2; 79 | $codehilite-name-extension: #EC407A; 80 | 81 | // Numbers 82 | $codehilite-literal-number: #E74C3C; 83 | $codehilite-literal-number-float: #E74C3C; 84 | $codehilite-literal-number-hex: #E74C3C; 85 | $codehilite-literal-number-integer: #E74C3C; 86 | $codehilite-literal-number-integer-long: #E74C3C; 87 | $codehilite-literal-number-oct: #E74C3C; 88 | 89 | // Strings 90 | $codehilite-literal-string: #0D904F; 91 | $codehilite-literal-string-backticks: #0D904F; 92 | $codehilite-literal-string-char: #0D904F; 93 | $codehilite-literal-string-doc: #999999; 94 | $codehilite-literal-string-double: #0D904F; 95 | $codehilite-literal-string-escape: #183691; 96 | $codehilite-literal-string-heredoc: #183691; 97 | $codehilite-literal-string-interpol: #183691; 98 | $codehilite-literal-string-other: #183691; 99 | $codehilite-literal-string-regex: #009926; 100 | $codehilite-literal-string-single: #0D904F; 101 | $codehilite-literal-string-symbol: #0D904F; 102 | 103 | // Miscellaneous 104 | $codehilite-error: #A61717; 105 | $codehilite-whitespace: transparent; 106 | 107 | // ---------------------------------------------------------------------------- 108 | // Rules: syntax highlighting 109 | // ---------------------------------------------------------------------------- 110 | 111 | // Codehilite extension 112 | .codehilite { 113 | 114 | // Operators 115 | .o { color: $codehilite-operator; } 116 | .ow { color: $codehilite-operator-word; } 117 | 118 | // Generics 119 | .ge { color: $codehilite-generic-emph; } 120 | .gr { color: $codehilite-generic-error; } 121 | .gh { color: $codehilite-generic-heading; } 122 | .go { color: $codehilite-generic-output; } 123 | .gp { color: $codehilite-generic-prompt; } 124 | .gs { color: $codehilite-generic-strong; } 125 | .gu { color: $codehilite-generic-subheading; } 126 | .gt { color: $codehilite-generic-traceback; } 127 | 128 | // Diffs 129 | .gd { background-color: $codehilite-diff-deleted; } 130 | .gi { background-color: $codehilite-diff-inserted; } 131 | 132 | // Keywords 133 | .k { color: $codehilite-keyword; } 134 | .kc { color: $codehilite-keyword-constant; } 135 | .kd { color: $codehilite-keyword-declaration; } 136 | .kn { color: $codehilite-keyword-namespace; } 137 | .kp { color: $codehilite-keyword-pseudo; } 138 | .kr { color: $codehilite-keyword-reserved; } 139 | .kt { color: $codehilite-keyword-type; } 140 | 141 | // Comments 142 | .c { color: $codehilite-comment; } 143 | .cm { color: $codehilite-comment-multiline; } 144 | .cp { color: $codehilite-comment-preproc; } 145 | .c1 { color: $codehilite-comment-single; } 146 | .ch { color: $codehilite-comment-shebang; } 147 | .cs { color: $codehilite-comment-special; } 148 | 149 | // Names 150 | .na { color: $codehilite-name-attribute; } 151 | .nb { color: $codehilite-name-builtin; } 152 | .bp { color: $codehilite-name-builtin-pseudo; } 153 | .nc { color: $codehilite-name-class; } 154 | .no { color: $codehilite-name-constant; } 155 | .nd { color: $codehilite-name-entity; } 156 | .ni { color: $codehilite-name-entity; } 157 | .ne { color: $codehilite-name-exception; } 158 | .nf { color: $codehilite-name-function; } 159 | .nl { color: $codehilite-name-label; } 160 | .nn { color: $codehilite-name-namespace; } 161 | .nt { color: $codehilite-name-tag; } 162 | .nv { color: $codehilite-name-variable; } 163 | .vc { color: $codehilite-name-variable-class; } 164 | .vg { color: $codehilite-name-variable-global; } 165 | .vi { color: $codehilite-name-variable-instance; } 166 | .nx { color: $codehilite-name-extension; } 167 | 168 | // Numbers 169 | .m { color: $codehilite-literal-number; } 170 | .mf { color: $codehilite-literal-number-float; } 171 | .mh { color: $codehilite-literal-number-hex; } 172 | .mi { color: $codehilite-literal-number-integer; } 173 | .il { color: $codehilite-literal-number-integer-long; } 174 | .mo { color: $codehilite-literal-number-oct; } 175 | 176 | // Strings 177 | .s { color: $codehilite-literal-string; } 178 | .sb { color: $codehilite-literal-string-backticks; } 179 | .sc { color: $codehilite-literal-string-char; } 180 | .sd { color: $codehilite-literal-string-doc; } 181 | .s2 { color: $codehilite-literal-string-double; } 182 | .se { color: $codehilite-literal-string-escape; } 183 | .sh { color: $codehilite-literal-string-heredoc; } 184 | .si { color: $codehilite-literal-string-interpol; } 185 | .sx { color: $codehilite-literal-string-other; } 186 | .sr { color: $codehilite-literal-string-regex; } 187 | .s1 { color: $codehilite-literal-string-single; } 188 | .ss { color: $codehilite-literal-string-symbol; } 189 | 190 | // Miscellaneous 191 | .err { color: $codehilite-error; } 192 | .w { color: $codehilite-whitespace; } 193 | 194 | // Highlighted lines 195 | .hll { 196 | display: block; 197 | margin: 0 px2rem(-12px); 198 | padding: 0 px2rem(12px); 199 | background-color: transparentize($clr-yellow-500, 0.5); 200 | 201 | // [mobile -]: Stretch to whole width 202 | @include break-to-device(mobile) { 203 | margin: 0 px2rem(-16px); 204 | padding: 0 px2rem(16px); 205 | } 206 | } 207 | } 208 | 209 | // ---------------------------------------------------------------------------- 210 | // Rules: layout 211 | // ---------------------------------------------------------------------------- 212 | 213 | // Scoped in typesetted content to match specificity of regular content 214 | article { 215 | 216 | // If code blocks are wrapped with codehilite, the styles must be adjusted 217 | // so the marker stretches to the whole width and the padding is respected 218 | .codehilite { 219 | position: relative; 220 | margin: 1em 0; 221 | padding: 0; 222 | border-radius: px2rem(2px); 223 | background-color: $md-code-background; 224 | color: $md-code-color; 225 | line-height: 1.4; 226 | -webkit-overflow-scrolling: touch; 227 | 228 | // Actual container with code, overflowing 229 | pre, 230 | code { 231 | display: block; 232 | margin: 0; 233 | padding: px2rem(10.5px) px2rem(12px); 234 | background-color: transparent; 235 | overflow: auto; 236 | vertical-align: top; 237 | 238 | // Override native scrollbar styles 239 | &::-webkit-scrollbar { 240 | width: px2rem(4px); 241 | height: px2rem(4px); 242 | } 243 | 244 | // Style scrollbar thumb 245 | &::-webkit-scrollbar-thumb { 246 | background-color: $md-color-black--lighter; 247 | 248 | // Hovered scrollbar thumb 249 | &:hover { 250 | background-color: $md-color-accent; 251 | } 252 | } 253 | } 254 | } 255 | 256 | // If not using Pygments, code will be under pre > code 257 | pre.codehilite { 258 | overflow: visible; 259 | 260 | // Actual container with code, overflowing 261 | code { 262 | display: block; 263 | padding: px2rem(10.5px) px2rem(12px); 264 | overflow: auto; 265 | } 266 | } 267 | 268 | // Block with line numbers 269 | .codehilitetable { 270 | display: block; 271 | margin: 1em 0; 272 | border-radius: 0.2em; 273 | font-size: ms(0); 274 | overflow: hidden; 275 | 276 | // Set table elements to block layout, because otherwise the whole flexbox 277 | // hacking won't work correctly 278 | tbody, 279 | td { 280 | display: block; 281 | padding: 0; 282 | } 283 | 284 | // We need to use flexbox layout, because otherwise it's not possible to 285 | // make the code container scroll while keeping the line numbers static 286 | tr { 287 | display: flex; 288 | } 289 | 290 | // The pre tags are nested inside a table, so we need to remove the 291 | // margin because it collapses below all the overflows 292 | .codehilite, 293 | .linenodiv { 294 | margin: 0; 295 | border-radius: 0; 296 | } 297 | 298 | // Add spacing to line number container 299 | .linenodiv { 300 | padding: px2rem(10.5px) px2rem(12px); 301 | } 302 | 303 | // Disable user selection, so code can be easily copied without 304 | // accidentally also copying the line numbers 305 | .linenos { 306 | background-color: $md-color-black--lightest; 307 | color: $md-color-black--lighter; 308 | user-select: none; 309 | 310 | // Reset spacings 311 | pre { 312 | margin: 0; 313 | padding: 0; 314 | background-color: transparent; 315 | color: inherit; 316 | text-align: right; 317 | } 318 | } 319 | 320 | // The table cell containing the code container wrapper and code should 321 | // stretch horizontally to the remaining space 322 | .code { 323 | flex: 1; 324 | overflow: hidden; 325 | } 326 | } 327 | 328 | // Full-width container 329 | > .codehilite { 330 | 331 | // [mobile -]: Stretch to whole width 332 | @include break-to-device(mobile) { 333 | margin: 1em px2rem(-16px); 334 | border-radius: 0; 335 | 336 | // Actual container with code, overflowing 337 | pre, 338 | code { 339 | padding: px2rem(10.5px) px2rem(16px); 340 | } 341 | } 342 | } 343 | 344 | // Full-width container on top-level 345 | > .codehilitetable { 346 | box-shadow: none; 347 | 348 | // [mobile -]: Stretch to whole width 349 | @include break-to-device(mobile) { 350 | margin: 1em px2rem(-16px); 351 | border-radius: 0; 352 | 353 | // Increase spacing 354 | .codehilite > pre, 355 | .codehilite > code, 356 | .linenodiv { 357 | padding: px2rem(10px) px2rem(16px); 358 | } 359 | } 360 | } 361 | 362 | // When pymdownx.superfences is enabled but codehilite is disabled, 363 | // pymdownx.highlight will be used. When this happens, the outer 364 | // container and tables get this class names by default. 365 | .highlight { 366 | @extend .codehilite; 367 | } 368 | 369 | // Same as above, but for code blocks with line numbers enabled 370 | .highlighttable { 371 | @extend .codehilitetable; 372 | } 373 | } 374 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/_footnotes.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Rules 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Scoped in typesetted content to match specificity of regular content 28 | article { 29 | 30 | // All footnote references 31 | [id^="fnref:"] { 32 | display: inline-block; 33 | 34 | // Targeted anchor 35 | &:target { 36 | margin-top: -1 * px2rem(48px + 12px + 16px); 37 | padding-top: px2rem(48px + 12px + 16px); 38 | pointer-events: none; 39 | } 40 | } 41 | 42 | // All footnote back references 43 | [id^="fn:"] { 44 | 45 | // Add spacing to anchor for offset 46 | &::before { 47 | display: none; 48 | height: 0; 49 | content: ""; 50 | } 51 | 52 | // Targeted anchor 53 | &:target::before { 54 | display: block; 55 | margin-top: -1 * px2rem(48px + 12px + 10px); 56 | padding-top: px2rem(48px + 12px + 10px); 57 | pointer-events: none; 58 | } 59 | } 60 | 61 | // Footnotes extension 62 | .footnote { 63 | color: $md-color-black--light; 64 | font-size: ms(-1); 65 | 66 | // Remove additional spacing on footnotes 67 | ol { 68 | margin-left: 0; 69 | } 70 | 71 | // Footnote 72 | li { 73 | transition: color 0.25s; 74 | 75 | // Darken color for targeted footnote 76 | &:target { 77 | color: $md-color-black; 78 | } 79 | 80 | // Remove spacing on first element 81 | :first-child { 82 | margin-top: 0; 83 | } 84 | 85 | // Make back references visible on hover 86 | &:hover .footnote-backref, 87 | &:target .footnote-backref { 88 | transform: translateX(0); 89 | opacity: 1; 90 | } 91 | 92 | // Active or targeted back reference 93 | &:hover .footnote-backref:hover, 94 | &:target .footnote-backref { 95 | color: $md-color-accent; 96 | } 97 | } 98 | } 99 | 100 | // Footnote reference 101 | .footnote-ref { 102 | display: inline-block; 103 | pointer-events: initial; 104 | 105 | // Render a thin line before footnote 106 | &::before { 107 | display: inline; 108 | margin: 0 0.2em; 109 | border-left: px2rem(1px) solid $md-color-black--lighter; 110 | font-size: 1.25em; 111 | content: ""; 112 | vertical-align: px2rem(-5px); 113 | } 114 | } 115 | 116 | // Footnote back reference 117 | .footnote-backref { 118 | @extend %md-icon; 119 | 120 | display: inline-block; 121 | transform: translateX(px2rem(5px)); 122 | transition: 123 | transform 0.25s 0.125s, 124 | color 0.25s, 125 | opacity 0.125s 0.125s; 126 | color: $md-color-black--lighter; 127 | // Hack: remove Unicode arrow for icon 128 | font-size: 0; 129 | opacity: 0; 130 | vertical-align: text-bottom; 131 | 132 | // Adjust for RTL languages 133 | [dir="rtl"] & { 134 | transform: translateX(px2rem(-5px)); 135 | } 136 | 137 | // Back reference icon 138 | &::before { 139 | display: inline-block; 140 | font-size: px2rem(16px); 141 | content: "\E31B"; // keyboard_return 142 | 143 | // Adjust for RTL languages 144 | [dir="rtl"] & { 145 | transform: scaleX(-1) 146 | } 147 | } 148 | } 149 | } 150 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/pymdown/_arithmatex.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // stylelint-disable selector-class-pattern 24 | 25 | // ---------------------------------------------------------------------------- 26 | // Rules 27 | // ---------------------------------------------------------------------------- 28 | 29 | // Scoped in typesetted content to match specificity of regular content 30 | article { 31 | 32 | // MathJax integration - add padding to omit vertical scrollbar 33 | .MJXc-display { 34 | margin: 0.75em 0; 35 | padding: 0.75em 0; 36 | overflow: auto; 37 | -webkit-overflow-scrolling: touch; 38 | } 39 | 40 | // Stretch top-level containers 41 | > p > .MJXc-display { 42 | 43 | // [mobile -]: Stretch to whole width 44 | @include break-to-device(mobile) { 45 | margin: 0.75em px2rem(-16px); 46 | padding: 0.25em px2rem(16px); 47 | } 48 | } 49 | 50 | // Remove outline on tab index 51 | .MathJax_CHTML { 52 | outline: 0; 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/pymdown/_critic.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Rules 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Scoped in typesetted content to match specificity of regular content 28 | article { 29 | 30 | // Deletions, additions and comments 31 | del.critic, 32 | ins.critic, 33 | .critic.comment { 34 | margin: 0 0.25em; 35 | padding: 0.0625em 0; 36 | border-radius: px2rem(2px); 37 | box-decoration-break: clone; 38 | } 39 | 40 | // Deletion 41 | del.critic { 42 | background-color: $codehilite-diff-deleted; // TODO: dependent on order of inclusion 43 | box-shadow: 44 | +0.25em 0 0 $codehilite-diff-deleted, 45 | -0.25em 0 0 $codehilite-diff-deleted; 46 | } 47 | 48 | // Addition 49 | ins.critic { 50 | background-color: $codehilite-diff-inserted; // TODO: dependent on order of inclusion 51 | box-shadow: 52 | +0.25em 0 0 $codehilite-diff-inserted, 53 | -0.25em 0 0 $codehilite-diff-inserted; 54 | } 55 | 56 | // Comment 57 | .critic.comment { 58 | background-color: $md-code-background; // TODO: rename, centralize somehow 59 | color: $md-code-color; 60 | box-shadow: 61 | +0.25em 0 0 $md-code-background, 62 | -0.25em 0 0 $md-code-background; 63 | 64 | // Icon 65 | &::before { 66 | @extend %md-icon; 67 | 68 | padding-right: 0.125em; 69 | color: $md-color-black--lighter; 70 | content: "\E0B7"; // chat 71 | vertical-align: -0.125em; 72 | } 73 | } 74 | 75 | // Block 76 | .critic.block { 77 | display: block; 78 | margin: 1em 0; 79 | padding-right: px2rem(16px); 80 | padding-left: px2rem(16px); 81 | box-shadow: none; 82 | 83 | // Decrease spacing on first element 84 | :first-child { 85 | margin-top: 0.5em; 86 | } 87 | 88 | // Decrease spacing on last element 89 | :last-child { 90 | margin-bottom: 0.5em; 91 | } 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/pymdown/_details.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Rules 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Scoped in typesetted content to match specificity of regular content 28 | article { 29 | 30 | // Details extension 31 | details { 32 | @extend .admonition; 33 | 34 | display: block; 35 | padding-top: 0; 36 | 37 | // Rotate title icon 38 | &[open] > summary::after { 39 | transform: rotate(180deg); 40 | } 41 | 42 | // Remove bottom spacing 43 | &:not([open]) { 44 | padding-bottom: 0; 45 | 46 | // Remove bottom border if block is closed 47 | > summary { 48 | border-bottom: none; 49 | } 50 | } 51 | 52 | // Increase spacing to the right - scoped here for higher specificity 53 | summary { 54 | padding-right: px2rem(40px); 55 | 56 | // Adjust for RTL languages 57 | [dir="rtl"] & { 58 | padding-left: px2rem(40px); 59 | } 60 | } 61 | 62 | // Manually hide and show, if browser doesn't support details 63 | .no-details &:not([open]) { 64 | 65 | // Hide all nested tags ... 66 | > * { 67 | display: none; 68 | } 69 | 70 | // ... but show title 71 | summary { 72 | display: block; 73 | } 74 | } 75 | } 76 | 77 | // Title 78 | summary { 79 | @extend .admonition-title; 80 | 81 | // Hack: set to block, so Firefox doesn't render marker 82 | display: block; 83 | outline: none; 84 | cursor: pointer; 85 | 86 | // Remove default details marker 87 | &::-webkit-details-marker { 88 | display: none; 89 | } 90 | 91 | // Icon 92 | &::after { 93 | @extend %md-icon; 94 | 95 | position: absolute; 96 | top: px2rem(8px); 97 | right: px2rem(12px); 98 | color: $md-color-black--lighter; 99 | font-size: px2rem(20px); 100 | content: "\E313"; // keyboard_arrow_down 101 | 102 | // Adjust for RTL languages 103 | [dir="rtl"] & { 104 | right: initial; 105 | left: px2rem(12px); 106 | } 107 | } 108 | } 109 | } 110 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/pymdown/_emoji.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Rules 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Scoped in typesetted content to match specificity of regular content 28 | article { 29 | 30 | // Correct alignment of emojis 31 | .emojione { 32 | width: px2rem(20px); 33 | vertical-align: text-top; 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/pymdown/_inlinehilite.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Rules 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Scoped in typesetted content to match specificity of regular content 28 | article { 29 | 30 | // Qualified class selector to distinguish inline code from code blocks 31 | code.codehilite { 32 | $correct: 1 / 0.85; 33 | 34 | margin: 0 0.25em * $correct; 35 | padding: 0.0625em * $correct 0; 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/pymdown/_superfences.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Rules 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Scoped in typesetted content to match specificity of regular content 28 | article { 29 | 30 | // Tabbed code block content 31 | .superfences-content { 32 | display: none; 33 | order: 99; 34 | width: 100%; 35 | background-color: $md-color-white; 36 | 37 | // Actual content 38 | > * { 39 | margin: 0; 40 | border-radius: 0 41 | } 42 | } 43 | 44 | // Tabbed code block container 45 | .superfences-tabs { 46 | display: flex; 47 | position: relative; 48 | flex-wrap: wrap; 49 | margin: 1em 0; 50 | border: px2rem(1px) solid $md-color-black--lightest; 51 | border-radius: 0.2em; 52 | 53 | // Hide radio buttons 54 | > input { 55 | display: none; 56 | 57 | // Active tab label 58 | &:checked + label { 59 | font-weight: 700; 60 | 61 | // Show code tab content 62 | & + .superfences-content { 63 | display: block; 64 | } 65 | } 66 | } 67 | 68 | // Tab label 69 | > label { 70 | width: auto; 71 | padding: px2rem(12px); 72 | transition: color 0.125s; 73 | font-size: ms(-1); 74 | cursor: pointer; 75 | 76 | // Hovered tab label 77 | html &:hover { 78 | color: $md-color-accent; 79 | } 80 | } 81 | } 82 | 83 | // Full-width container on top-level 84 | > .superfences-tabs { 85 | 86 | // [mobile -]: Stretch to whole width 87 | @include break-to-device(mobile) { 88 | margin: 1em px2rem(-16px); 89 | border: 0; 90 | border-top: px2rem(1px) solid $md-color-black--lightest; 91 | border-radius: 0; 92 | 93 | // Actual container with code, overflowing 94 | pre, 95 | code { 96 | padding: px2rem(10.5px) px2rem(16px); 97 | } 98 | } 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/extensions/pymdown/_tasklist.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Rules 25 | // ---------------------------------------------------------------------------- 26 | 27 | // Scoped in typesetted content to match specificity of regular content 28 | article { 29 | 30 | // Remove list icon on task items 31 | .task-list-item { 32 | position: relative; 33 | list-style-type: none; 34 | 35 | // Make checkbox items align with normal list items, but position 36 | // everything in ems for correct layout at smaller font sizes 37 | [type="checkbox"] { 38 | position: absolute; 39 | top: 0.45em; 40 | left: -2em; 41 | 42 | // Adjust for RTL languages 43 | [dir="rtl"] & { 44 | right: -2em; 45 | left: initial; 46 | } 47 | } 48 | } 49 | 50 | // Wrapper for list controls, in case custom checkboxes are enabled 51 | .task-list-control { 52 | 53 | // Checkbox icon in unchecked state 54 | .task-list-indicator::before { 55 | @extend %md-icon; 56 | 57 | position: absolute; 58 | top: 0.15em; 59 | left: -1.25em; 60 | color: $md-color-black--lighter; 61 | font-size: 1.25em; 62 | content: "\E835"; // check_box_outline_blank 63 | vertical-align: -0.25em; 64 | 65 | // Adjust for RTL languages 66 | [dir="rtl"] & { 67 | right: -1.25em; 68 | left: initial; 69 | } 70 | } 71 | 72 | // Checkbox icon in checked state 73 | [type="checkbox"]:checked + .task-list-indicator::before { 74 | content: "\E834"; // check_box 75 | } 76 | 77 | // Hide original checkbox behind icon 78 | [type="checkbox"] { 79 | opacity: 0; 80 | z-index: -1; 81 | } 82 | } 83 | } 84 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/helpers/_break.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // ---------------------------------------------------------------------------- 24 | // Variables 25 | // ---------------------------------------------------------------------------- 26 | 27 | /// 28 | /// Device-specific breakpoints 29 | /// 30 | /// @example 31 | /// $break-devices: ( 32 | /// mobile: ( 33 | /// portrait: 220px 479px, 34 | /// landscape: 480px 719px 35 | /// ), 36 | /// tablet: ( 37 | /// portrait: 720px 959px, 38 | /// landscape: 960px 1219px 39 | /// ), 40 | /// screen: ( 41 | /// small: 1220px 1599px, 42 | /// medium: 1600px 1999px, 43 | /// large: 2000px 44 | /// ) 45 | /// ); 46 | /// 47 | /// @group helpers 48 | /// @access private 49 | /// @type Map 50 | /// 51 | $break-devices: () !default; 52 | 53 | // ---------------------------------------------------------------------------- 54 | // Helpers 55 | // ---------------------------------------------------------------------------- 56 | 57 | /// 58 | /// Choose minimum and maximum device widths 59 | /// 60 | /// @group helpers 61 | /// @access private 62 | /// @param {Map} $devices Map of devices 63 | /// @return {List} Minimum and maximum width 64 | /// 65 | @function break-select-min-max($devices) { 66 | $min: 1000000; 67 | $max: 0; 68 | @each $key, $value in $devices { 69 | @while type-of($value) == map { 70 | $value: break-select-min-max($value); 71 | } 72 | @if type-of($value) == list { 73 | @each $number in $value { 74 | @if type-of($number) == number { 75 | $min: min($number, $min); 76 | @if $max != null { 77 | $max: max($number, $max); 78 | } 79 | } @else { 80 | @error "Invalid number: #{$number}"; 81 | } 82 | } 83 | } @elseif type-of($value) == number { 84 | $min: min($value, $min); 85 | $max: null; 86 | } @else { 87 | @error "Invalid value: #{$value}"; 88 | } 89 | } 90 | @return $min, $max; 91 | } 92 | 93 | /// 94 | /// Select minimum and maximum widths for a device breakpoint 95 | /// 96 | /// @group helpers 97 | /// @access private 98 | /// @param {String} $device Device 99 | /// @return {List} Minimum and maximum width 100 | /// 101 | @function break-select-device($device) { 102 | $current: $break-devices; 103 | @for $n from 1 through length($device) { 104 | @if type-of($current) == map { 105 | $current: map-get($current, nth($device, $n)); 106 | } @else { 107 | @error "Invalid device map: #{$devices}"; 108 | } 109 | } 110 | @if type-of($current) == list or type-of($current) == number { 111 | $current: (default: $current); 112 | } 113 | @return break-select-min-max($current); 114 | } 115 | 116 | // ---------------------------------------------------------------------------- 117 | // Mixins 118 | // ---------------------------------------------------------------------------- 119 | 120 | /// 121 | /// A minimum-maximum media query breakpoint 122 | /// 123 | /// @group helpers 124 | /// @access public 125 | /// @param {Number|List} $breakpoint Number or number pair 126 | /// 127 | @mixin break-at($breakpoint) { 128 | @if type-of($breakpoint) == number { 129 | @media only screen and (min-width: $breakpoint) { 130 | @content; 131 | } 132 | } @elseif type-of($breakpoint) == list { 133 | $min: nth($breakpoint, 1); 134 | $max: nth($breakpoint, 2); 135 | @if type-of($min) == number and type-of($max) == number { 136 | @media only screen and (min-width: $min) and (max-width: $max) { 137 | @content; 138 | } 139 | } @else { 140 | @error "Invalid breakpoint: #{$breakpoint}"; 141 | } 142 | } @else { 143 | @error "Invalid breakpoint: #{$breakpoint}"; 144 | } 145 | } 146 | 147 | /// 148 | /// An orientation media query breakpoint 149 | /// 150 | /// @group helpers 151 | /// @access public 152 | /// @param {String} $breakpoint Orientation 153 | /// 154 | @mixin break-at-orientation($breakpoint) { 155 | @if type-of($breakpoint) == string { 156 | @media only screen and (orientation: $breakpoint) { 157 | @content; 158 | } 159 | } @else { 160 | @error "Invalid breakpoint: #{$breakpoint}"; 161 | } 162 | } 163 | 164 | /// 165 | /// A maximum-aspect-ratio media query breakpoint 166 | /// 167 | /// @group helpers 168 | /// @access public 169 | /// @param {Number} $breakpoint Ratio 170 | /// 171 | @mixin break-at-ratio($breakpoint) { 172 | @if type-of($breakpoint) == number { 173 | @media only screen and (max-aspect-ratio: $breakpoint) { 174 | @content; 175 | } 176 | } @else { 177 | @error "Invalid breakpoint: #{$breakpoint}"; 178 | } 179 | } 180 | 181 | /// 182 | /// A minimum-maximum media query device breakpoint 183 | /// 184 | /// @group helpers 185 | /// @access public 186 | /// @param {String|List} $breakpoint Device 187 | /// 188 | @mixin break-at-device($device) { 189 | @if type-of($device) == string { 190 | $device: $device,; 191 | } 192 | @if type-of($device) == list { 193 | $breakpoint: break-select-device($device); 194 | @if nth($breakpoint, 2) != null { 195 | $min: nth($breakpoint, 1); 196 | $max: nth($breakpoint, 2); 197 | @media only screen and (min-width: $min) and (max-width: $max) { 198 | @content; 199 | } 200 | } @else { 201 | @error "Invalid device: #{$device}"; 202 | } 203 | } @else { 204 | @error "Invalid device: #{$device}"; 205 | } 206 | } 207 | 208 | /// 209 | /// A minimum media query device breakpoint 210 | /// 211 | /// @group helpers 212 | /// @access public 213 | /// @param {String|List} $breakpoint Device 214 | /// 215 | @mixin break-from-device($device) { 216 | @if type-of($device) == string { 217 | $device: $device,; 218 | } 219 | @if type-of($device) == list { 220 | $breakpoint: break-select-device($device); 221 | $min: nth($breakpoint, 1); 222 | @media only screen and (min-width: $min) { 223 | @content; 224 | } 225 | } @else { 226 | @error "Invalid device: #{$device}"; 227 | } 228 | } 229 | 230 | /// 231 | /// A maximum media query device breakpoint 232 | /// 233 | /// @group helpers 234 | /// @access public 235 | /// @param {String|List} $breakpoint Device 236 | /// 237 | @mixin break-to-device($device) { 238 | @if type-of($device) == string { 239 | $device: $device,; 240 | } 241 | @if type-of($device) == list { 242 | $breakpoint: break-select-device($device); 243 | $max: nth($breakpoint, 2); 244 | @media only screen and (max-width: $max) { 245 | @content; 246 | } 247 | } @else { 248 | @error "Invalid device: #{$device}"; 249 | } 250 | } 251 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/design/stylesheets/helpers/_px2em.scss: -------------------------------------------------------------------------------- 1 | //// 2 | /// Copyright (c) 2016-2019 Martin Donath 3 | /// 4 | /// Permission is hereby granted, free of charge, to any person obtaining a 5 | /// copy of this software and associated documentation files (the "Software"), 6 | /// to deal in the Software without restriction, including without limitation 7 | /// the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 | /// and/or sell copies of the Software, and to permit persons to whom the 9 | /// Software is furnished to do so, subject to the following conditions: 10 | /// 11 | /// The above copyright notice and this permission notice shall be included in 12 | /// all copies or substantial portions of the Software. 13 | /// 14 | /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | /// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 17 | /// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 | /// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 | /// DEALINGS 21 | //// 22 | 23 | // stylelint-disable unit-whitelist 24 | 25 | // ---------------------------------------------------------------------------- 26 | // Helpers 27 | // ---------------------------------------------------------------------------- 28 | 29 | /// 30 | /// Convert font size in px to em. 31 | /// 32 | /// @group helpers 33 | /// @access public 34 | /// @param {Number} $size Font size in px 35 | /// @param {Number} $base Base font size 36 | /// @return {Number} Font size in em 37 | /// 38 | @function px2em($size, $base: 16px) { 39 | @if unit($size) == px { 40 | @if unit($base) == px { 41 | @return ($size / $base) * 1em; 42 | } @else { 43 | @error "Invalid base: #{$base} - unit must be 'px'"; 44 | } 45 | } @else { 46 | @error "Invalid size: #{$size} - unit must be 'px'"; 47 | } 48 | } 49 | 50 | /// 51 | /// Convert font size in px to rem. 52 | /// 53 | /// @group helpers 54 | /// @access public 55 | /// @param {Number} $size Font size in px 56 | /// @param {Number} $base Base font size 57 | /// @return {Number} Font size in rem 58 | /// 59 | @function px2rem($size, $base: 20px) { 60 | @if unit($size) == px { 61 | @if unit($base) == px { 62 | @return ($size / $base) * 1.0rem; 63 | } @else { 64 | @error "Invalid base: #{$base} - unit must be 'px'"; 65 | } 66 | } @else { 67 | @error "Invalid size: #{$size} - unit must be 'px'"; 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/generator.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | import sys 4 | from uuid import uuid4 5 | 6 | from weasyprint import HTML, urls, CSS 7 | from bs4 import BeautifulSoup 8 | from weasyprint.fonts import FontConfiguration 9 | 10 | from mkpdfs_mkdocs.utils import gen_address 11 | from .utils import is_external 12 | from mkpdfs_mkdocs.preprocessor import get_separate as prep_separate, get_combined as prep_combined 13 | 14 | log = logging.getLogger(__name__) 15 | 16 | 17 | class Generator(object): 18 | 19 | def __init__(self): 20 | self.config = None 21 | self.design = None 22 | self.mkdconfig = None 23 | self.nav = None 24 | self.title = None 25 | self.logger = logging.getLogger('mkdocs.mkpdfs') 26 | self.generate = True 27 | self._articles = {} 28 | self._page_order = [] 29 | self._base_urls = {} 30 | self._toc = None 31 | self.html = BeautifulSoup('\ 32 | ', 33 | 'html.parser') 34 | self.dir = os.path.dirname(os.path.realpath(__file__)) 35 | self.design = os.path.join(self.dir, 'design/report.css') 36 | 37 | def set_config(self, local, config): 38 | self.config = local 39 | if self.config['design']: 40 | css_file = os.path.join(os.getcwd(), self.config['design']) 41 | if not os.path.isfile(css_file): 42 | sys.exit('The file {} specified for design has not \ 43 | been found.'.format(css_file)) 44 | self.design = css_file 45 | self.title = config['site_name'] 46 | self.config['copyright'] = 'CC-BY-SA\ 47 | ' if not config['copyright'] else config['copyright'] 48 | self.mkdconfig = config 49 | 50 | def write(self): 51 | if not self.generate: 52 | self.logger.log(msg='Unable to generate the PDF Version (See Mkpdfs doc)', 53 | level=logging.WARNING, ) 54 | return 55 | self.gen_articles() 56 | font_config = FontConfiguration() 57 | self.add_head() 58 | pdf_path = os.path.join(self.mkdconfig['site_dir'], 59 | self.config['output_path']) 60 | os.makedirs(os.path.dirname(pdf_path), exist_ok=True) 61 | html = HTML(string=str(self.html)).write_pdf(pdf_path, 62 | font_config=font_config) 63 | self.logger.log(msg='The PDF version of the documentation has been generated.', level=logging.INFO, ) 64 | 65 | def add_nav(self, nav): 66 | self.nav = nav 67 | for p in nav: 68 | self.add_to_order(p) 69 | 70 | def add_to_order(self, page): 71 | if page.is_page and page.meta and 'pdf' in page.meta and not page.meta['pdf']: 72 | return 73 | if page.is_page: 74 | self._page_order.append(page.file.url) 75 | elif page.children: 76 | uuid = str(uuid4()) 77 | self._page_order.append(uuid) 78 | title = self.html.new_tag('h1', 79 | id='{}-title'.format(uuid), 80 | **{'class': 'section_title'} 81 | ) 82 | title.append(page.title) 83 | article = self.html.new_tag('article', 84 | id='{}'.format(uuid), 85 | **{'class': 'chapter'} 86 | ) 87 | article.append(title) 88 | self._articles[uuid] = article 89 | for child in page.children: 90 | self.add_to_order(child) 91 | 92 | def remove_from_order(self, item): 93 | return 94 | 95 | def add_article(self, content, page, base_url): 96 | if not self.generate: 97 | return None 98 | self._base_urls[page.file.url] = base_url 99 | soup = BeautifulSoup(content, 'html.parser') 100 | url = page.url.split('.')[0] 101 | article = soup.find('article') 102 | if not article: 103 | article = self.html.new_tag('article') 104 | eld = soup.find('div', **{'role': 'main'}) 105 | article.append(eld) 106 | article.div['class'] = article.div['role'] = None 107 | 108 | if not article: 109 | self.generate = False 110 | return None 111 | article = prep_combined(article, base_url, page.file.url) 112 | if page.meta and 'pdf' in page.meta and not page.meta['pdf']: 113 | # print(page.meta) 114 | return self.get_path_to_pdf(page.file.dest_path) 115 | self._articles[page.file.url] = article 116 | return self.get_path_to_pdf(page.file.dest_path) 117 | 118 | def add_head(self): 119 | lines = ['{}'.format(self.title)] 120 | for key, val in ( 121 | ("author", self.config['author'] or self.mkdconfig['site_author']), 122 | ("description", self.mkdconfig['site_description']), 123 | ): 124 | if val: 125 | lines.append(''.format(key, val)) 126 | for css in (self.design,): 127 | if css: 128 | css_tmpl = '' 129 | lines.append(css_tmpl.format(urls.path2url(css))) 130 | head = BeautifulSoup('\n'.join(lines), 'html5lib') 131 | self.html.head.clear() 132 | self.html.head.insert(0, head) 133 | 134 | def get_path_to_pdf(self, start): 135 | pdf_split = os.path.split(self.config['output_path']) 136 | start_dir = os.path.split(start)[0] 137 | return os.path.join(os.path.relpath(pdf_split[0], 138 | start_dir), pdf_split[1]) 139 | 140 | def add_tocs(self): 141 | title = self.html.new_tag('h1', id='toc-title') 142 | title.insert(0, self.config['toc_title']) 143 | self._toc = self.html.new_tag('article', id='contents') 144 | self._toc.insert(0, title) 145 | for n in self.nav: 146 | if n.is_page and n.meta and 'pdf' in n.meta \ 147 | and not n.meta['pdf']: 148 | continue 149 | if hasattr(n, 'url') and is_external(n.url): 150 | # Skip toc generation for external links 151 | continue 152 | h3 = self.html.new_tag('h3') 153 | h3.insert(0, n.title) 154 | self._toc.append(h3) 155 | if n.is_page: 156 | ptoc = self._gen_toc_page(n.file.url, n.toc) 157 | self._toc.append(ptoc) 158 | else: 159 | self._gen_toc_section(n) 160 | self.html.body.append(self._toc) 161 | 162 | def add_cover(self): 163 | a = self.html.new_tag('article', id='doc-cover') 164 | title = self.html.new_tag('h1', id='doc-title') 165 | title.insert(0, self.title) 166 | a.insert(0, title) 167 | a.append(gen_address(self.config)) 168 | self.html.body.append(a) 169 | 170 | def gen_articles(self): 171 | self.add_cover() 172 | if self.config['toc_position'] == 'pre': 173 | self.add_tocs() 174 | for url in self._page_order: 175 | if url in self._articles: 176 | self.html.body.append(self._articles[url]) 177 | if self.config['toc_position'] == 'post': 178 | self.add_tocs() 179 | 180 | def get_path_to_pdf(self, start): 181 | pdf_split = os.path.split(self.config['output_path']) 182 | start_dir = os.path.split(start)[0] if os.path.split(start)[0] else '.' 183 | return os.path.join(os.path.relpath(pdf_split[0], start_dir), 184 | pdf_split[1]) 185 | 186 | def _gen_toc_section(self, section): 187 | if section.children: # External Links do not have children 188 | for p in section.children: 189 | if p.is_page and p.meta and 'pdf' \ 190 | in p.meta and not p.meta['pdf']: 191 | continue 192 | if not hasattr(p, 'file'): 193 | # Skip external links 194 | continue 195 | stoc = self._gen_toc_for_section(p.file.url, p) 196 | child = self.html.new_tag('div') 197 | child.append(stoc) 198 | self._toc.append(child) 199 | 200 | def _gen_children(self, url, children): 201 | ul = self.html.new_tag('ul') 202 | for child in children: 203 | a = self.html.new_tag('a', href=child.url) 204 | a.insert(0, child.title) 205 | li = self.html.new_tag('li') 206 | li.append(a) 207 | if child.children: 208 | sub = self._gen_children(url, child.children) 209 | li.append(sub) 210 | ul.append(li) 211 | return ul 212 | 213 | def _gen_toc_for_section(self, url, p): 214 | div = self.html.new_tag('div') 215 | menu = self.html.new_tag('div') 216 | h4 = self.html.new_tag('h4') 217 | a = self.html.new_tag('a', href='#') 218 | a.insert(0, p.title) 219 | h4.append(a) 220 | menu.append(h4) 221 | ul = self.html.new_tag('ul') 222 | if p.toc: 223 | for child in p.toc.items: 224 | a = self.html.new_tag('a', href=child.url) 225 | a.insert(0, child.title) 226 | li = self.html.new_tag('li') 227 | li.append(a) 228 | if child.title == p.title: 229 | li = self.html.new_tag('div') 230 | if child.children: 231 | sub = self._gen_children(url, child.children) 232 | li.append(sub) 233 | ul.append(li) 234 | if len(p.toc.items) > 0: 235 | menu.append(ul) 236 | div.append(menu) 237 | div = prep_combined(div, self._base_urls[url], url) 238 | return div.find('div') 239 | 240 | def _gen_toc_page(self, url, toc): 241 | div = self.html.new_tag('div') 242 | menu = self.html.new_tag('ul') 243 | for item in toc.items: 244 | li = self.html.new_tag('li') 245 | a = self.html.new_tag('a', href=item.url) 246 | a.append(item.title) 247 | li.append(a) 248 | menu.append(li) 249 | if item.children: 250 | child = self._gen_children(url, item.children) 251 | menu.append(child) 252 | div.append(menu) 253 | div = prep_combined(div, self._base_urls[url], url) 254 | return div.find('ul') 255 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/mkpdfs.py: -------------------------------------------------------------------------------- 1 | import os 2 | import logging 3 | 4 | from mkdocs.config import config_options 5 | from mkdocs.plugins import BasePlugin 6 | 7 | from weasyprint import HTML, urls, CSS 8 | from mkpdfs_mkdocs.generator import Generator 9 | from mkpdfs_mkdocs.utils import modify_html 10 | 11 | log = logging.getLogger(__name__) 12 | 13 | 14 | class Mkpdfs(BasePlugin): 15 | 16 | config_scheme = ( 17 | ('design', config_options.Type(str, default=None)), 18 | ('toc_title', config_options.Type(str, default="Table of Contents")), 19 | ('company', config_options.Type(str, default=None)), 20 | ('author', config_options.Type(str, default=None)), 21 | ('toc_position', config_options.Type(str, default="pre")), 22 | ('pdf_links', config_options.Type(bool, default=True)), 23 | ('output_path', config_options.Type(str, default="pdf/combined.pdf")), 24 | ) 25 | 26 | def __init__(self): 27 | self.generator = Generator() 28 | self._skip_pdf = True if os.environ.get("SKIP_PDF") else False 29 | self._logger = logging.getLogger('mkdocs.mkpdfs') 30 | 31 | def on_serve(self, server, config, **kwargs): 32 | if self._skip_pdf: 33 | self._logger.info("PDF generation will be skipped: presence of env var SKIP_PDF=1") 34 | # TODO: Implement watcher when the user is performing design 35 | # print(server.watcher.__dict__) 36 | # # builder = build(config, True, False) 37 | # # server.watch(os.path.dirname(self.design), builder) 38 | return server 39 | 40 | def on_config(self, config, **kwargs): 41 | if self._skip_pdf: 42 | return config 43 | self.config['output_path'] = os.path.join("pdf", "combined.pdf") if not self.config['output_path'] else self.config['output_path'] 44 | self.generator.set_config(self.config, config) 45 | return config 46 | 47 | def on_nav(self, nav, config, **kwargs): 48 | if self._skip_pdf: 49 | return nav 50 | self.generator.add_nav(nav) 51 | return nav 52 | 53 | def on_post_page(self, output_content, page, config, **kwargs): 54 | if self._skip_pdf: 55 | return output_content 56 | try: 57 | abs_dest_path = page.file.abs_dest_path 58 | src_path = page.file.src_path 59 | except AttributeError: 60 | abs_dest_path = page.abs_output_path 61 | src_path = page.input_path 62 | path = os.path.dirname(abs_dest_path) 63 | os.makedirs(path, exist_ok=True) 64 | filename = os.path.splitext(os.path.basename(src_path))[0] 65 | base_url = urls.path2url(os.path.join(path, filename)) 66 | pdf_url = self.generator.add_article(output_content, page, base_url) 67 | if self.config['pdf_links'] and pdf_url: 68 | output_content = modify_html(output_content,pdf_url) 69 | return output_content 70 | 71 | def on_post_build(self, config): 72 | if self._skip_pdf: 73 | return 74 | self.generator.write() 75 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/preprocessor/__init__.py: -------------------------------------------------------------------------------- 1 | from .prep import get_combined, get_separate -------------------------------------------------------------------------------- /mkpdfs_mkdocs/preprocessor/links/__init__.py: -------------------------------------------------------------------------------- 1 | from .transform import transform_href, transform_id 2 | from .util import get_body_id, replace_asset_hrefs, rel_pdf_href -------------------------------------------------------------------------------- /mkpdfs_mkdocs/preprocessor/links/transform.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from .util import is_doc, normalize_href 4 | 5 | # normalize href to #foo/bar/section:id 6 | def transform_href(href: str, rel_url: str): 7 | if not is_doc(href): 8 | return href 9 | if '#' not in href: 10 | href += '#' 11 | return "#" + normalize_href(href, rel_url).replace("#", ":", 1) 12 | 13 | # normalize id to foo/bar/section:id 14 | def transform_id(id: str, rel_url: str): 15 | head, section = os.path.split(rel_url) 16 | 17 | if len(head) > 0: 18 | head += '/' 19 | 20 | return '{}{}:{}'.format(head, section, id) 21 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/preprocessor/links/util.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from weasyprint import urls 4 | from bs4 import BeautifulSoup 5 | 6 | 7 | # check if href is relative -- 8 | # if it is relative it *should* be an html that generates a PDF doc 9 | def is_doc(href: str): 10 | if urls.url_is_absolute(href): 11 | return False 12 | if os.path.isabs(href): 13 | return False 14 | 15 | return True 16 | 17 | 18 | def rel_pdf_href(href: str): 19 | head, tail = os.path.split(href) 20 | filename, _ = os.path.splitext(tail) 21 | 22 | internal = href.startswith('#') 23 | if not is_doc(href) or internal: 24 | return href 25 | 26 | return urls.iri_to_uri(os.path.join(head, filename + '.pdf')) 27 | 28 | def abs_asset_href(href: str, base_url: str): 29 | if urls.url_is_absolute(href) or os.path.isabs(href): 30 | return href 31 | 32 | return urls.iri_to_uri(urls.urljoin(base_url, href)) 33 | 34 | # makes all relative asset links absolute 35 | def replace_asset_hrefs(soup: BeautifulSoup, base_url: str): 36 | for link in soup.find_all('link', href=True): 37 | link['href'] = abs_asset_href(link['href'], base_url) 38 | 39 | for asset in soup.find_all(src=True): 40 | asset['src'] = abs_asset_href(asset['src'], base_url) 41 | 42 | return soup 43 | 44 | 45 | def normalize_href(href: str, rel_url: str): 46 | """ 47 | Normalize href to site root 48 | foo/bar/baz/../../index.html -> foo/index.html 49 | :param href: 50 | :param rel_url: 51 | :return: 52 | 53 | >>> normalize_href("../../index.html", "foo/bar/baz/page.html") 54 | 'foo/index.html' 55 | 56 | >>> normalize_href("page2.html#abcd", "foo/bar/baz/page.html") 57 | 'foo/bar/baz/page2.html#abcd' 58 | 59 | >>> normalize_href("#section", "foo/bar/baz/page.html") 60 | 'foo/bar/baz/page.html#section' 61 | 62 | >>> normalize_href("/index.html", "foo/bar/baz/page.html") 63 | '/index.html' 64 | 65 | >>> normalize_href("http://example.org/index.html", "foo/bar/baz/page.html") 66 | 'http://example.org/index.html' 67 | """ 68 | if not is_doc(href): 69 | return href 70 | if href.startswith("#"): 71 | return rel_url + href 72 | rel_dir = os.path.dirname(rel_url) 73 | return os.path.normpath(os.path.join(rel_dir, href)) 74 | 75 | 76 | def get_body_id(url: str): 77 | return '{}:'.format(url) -------------------------------------------------------------------------------- /mkpdfs_mkdocs/preprocessor/prep.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from .links import transform_href, transform_id, get_body_id, replace_asset_hrefs, rel_pdf_href 4 | 5 | from weasyprint import urls 6 | from bs4 import BeautifulSoup 7 | 8 | def get_combined(soup: BeautifulSoup, base_url: str, rel_url: str): 9 | for id in soup.find_all(id=True): 10 | id['id'] = transform_id(id['id'], rel_url) 11 | 12 | for a in soup.find_all('a', href=True): 13 | if urls.url_is_absolute(a['href']) or os.path.isabs(a['href']): 14 | a['class'] = 'external-link' 15 | continue 16 | 17 | a['href'] = transform_href(a['href'], rel_url) 18 | 19 | soup.attrs['id'] = get_body_id(rel_url) 20 | soup = replace_asset_hrefs(soup, base_url) 21 | return soup 22 | 23 | def get_separate(soup: BeautifulSoup, base_url: str): 24 | # transforms all relative hrefs pointing to other html docs 25 | # into relative pdf hrefs 26 | for a in soup.find_all('a', href=True): 27 | a['href'] = rel_pdf_href(a['href']) 28 | 29 | soup = replace_asset_hrefs(soup, base_url) 30 | return soup 31 | -------------------------------------------------------------------------------- /mkpdfs_mkdocs/utils.py: -------------------------------------------------------------------------------- 1 | from bs4 import BeautifulSoup 2 | 3 | 4 | def modify_html(html: str, href: str) -> str: 5 | soup = BeautifulSoup(html, 'html.parser') 6 | a = soup.new_tag('a', 7 | href=href, 8 | title='Download', 9 | download=None 10 | ) 11 | a['class'] = 'md-content__icon pdf-download-btn' 12 | i = soup.new_tag('i') 13 | i['class'] = 'fa fas fa-download' 14 | small = soup.new_tag('small') 15 | a.append(i) 16 | small.append(' PDF') 17 | a.append(small) 18 | if soup.article: 19 | soup.article.insert(0, a) 20 | else: 21 | soup.find('div', **{'role': 'main'}).insert(0, a); 22 | return str(soup) 23 | 24 | 25 | def gen_address(config): 26 | soup = BeautifulSoup('', 27 | 'html5lib' 28 | ) 29 | address = soup.new_tag('address') 30 | p = soup.new_tag('p') 31 | for k, line in {'author': config['author'], 32 | 'company': config['company']}.items(): 33 | if line: 34 | sp = soup.new_tag('p', **{'class': k}) 35 | sp.append("{}".format(line)) 36 | p.append(sp) 37 | address.append(p) 38 | if config['copyright']: 39 | span = soup.new_tag('p', 40 | id="copyright" 41 | ) 42 | span.append(config['copyright']) 43 | address.append(span) 44 | return address 45 | 46 | 47 | def is_external(href: str): 48 | return href.startswith('http://') or href.startswith('https://') 49 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | license_file = LICENSE 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | from os import path 3 | from io import open 4 | 5 | here = path.abspath(path.dirname(__file__)) 6 | 7 | with open(path.join(here, 'README.md'), encoding='utf-8') as f: 8 | long_description = f.read() 9 | 10 | 11 | setup( 12 | name='mkpdfs-mkdocs', 13 | version='1.0.1', 14 | url='https://mkpdfs.comwes.eu', 15 | license='GPLv3', 16 | author='Comwes', 17 | author_email='contact@comwes.eu', 18 | maintainer='Gerry Ntabuhashe', 19 | maintainer_email='gnt@comwes.eu', 20 | description='Allows the generation of the PDF version of your MkDocs documentation.', 21 | long_description=long_description, 22 | long_description_content_type='text/markdown', 23 | python_requires='>=3.4', 24 | include_package_data=True, 25 | install_requires=[ 26 | 'mkdocs>=0.17', 27 | 'weasyprint>=0.44', 28 | 'beautifulsoup4>=4.6.3' 29 | ], 30 | project_urls={ # Optional 31 | 'Bug Reports': 'https://github.com/comwes/mkpdfs-mkdocs-plugin/issues', 32 | 'Source': 'https://github.com/comwes/mkpdfs-mkdocs-plugin', 33 | }, 34 | keywords='mkdocs documentation pdf export weasyprint markdown plugin', 35 | classifiers=[ 36 | 'Development Status :: 4 - Beta', 37 | 'Intended Audience :: Developers', 38 | 'Intended Audience :: Education', 39 | 'Intended Audience :: Information Technology', 40 | 'Intended Audience :: System Administrators', 41 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 42 | 'Topic :: Documentation', 43 | 'Topic :: Printing', 44 | 'Programming Language :: Other', 45 | 'Programming Language :: Python :: 3 :: Only', 46 | 'Programming Language :: Python :: 3.4', 47 | 'Programming Language :: Python :: 3.5', 48 | 'Programming Language :: Python :: 3.6', 49 | 'Programming Language :: Python :: 3.7', 50 | 'Programming Language :: Python :: 3.8', 51 | ], 52 | packages=find_packages(), 53 | 54 | entry_points={ 55 | 'mkdocs.plugins': [ 56 | 'mkpdfs = mkpdfs_mkdocs:Mkpdfs', 57 | ] 58 | }, 59 | zip_safe=False, 60 | ) 61 | --------------------------------------------------------------------------------