diff options
| author | Fuwn <[email protected]> | 2022-02-04 17:38:04 -0800 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2025-06-09 00:43:14 -0700 |
| commit | 8a78f62e4cb0890cd0ed9c663a21f809013b959e (patch) | |
| tree | be25df618590569d62f3279a1c2cdffd7ddeeb08 | |
| download | documentation-8a78f62e4cb0890cd0ed9c663a21f809013b959e.tar.xz documentation-8a78f62e4cb0890cd0ed9c663a21f809013b959e.zip | |
feat: setup documentation
32 files changed, 2066 insertions, 0 deletions
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml new file mode 100644 index 0000000..5b36c8e --- /dev/null +++ b/.github/workflows/deploy.yaml @@ -0,0 +1,28 @@ +name: Deploy 🚀 +on: + push: + branches: + - main + +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - name: Cancel Previous Runs 🚫 + uses: styfle/[email protected] + with: + access_token: ${{ github.token }} + + - name: Checkout 🛎️ + uses: actions/[email protected] + + - name: Install and Build 🔧 + run: | + pip install -r requirements.txt + ivy build + + - name: Deploy 🚀 + uses: JamesIves/[email protected] + with: + branch: gh-pages + folder: out diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2c151df --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Ivy +/out/ + +# IDE +/.idea/ @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>.
\ No newline at end of file diff --git a/config.py b/config.py new file mode 100644 index 0000000..4385f9c --- /dev/null +++ b/config.py @@ -0,0 +1,13 @@ +# ------------------------------------------------------------------------------ +# Site Configuration File +# ------------------------------------------------------------------------------ + +# Choose the theme to use when building your site. This variable should specify +# the name of a theme directory in your site's 'lib' folder. +theme = "graphite" + +# Site title. +title = "Divina" + +# Site tagline. +tagline = "🎀 A modern build system for assembly" diff --git a/inc/menu.md b/inc/menu.md new file mode 100644 index 0000000..ba259bf --- /dev/null +++ b/inc/menu.md @@ -0,0 +1,2 @@ +* [Home](@root/) +* [About](@root/about//) diff --git a/lib/debug/license.txt b/lib/debug/license.txt new file mode 100644 index 0000000..53261fe --- /dev/null +++ b/lib/debug/license.txt @@ -0,0 +1,24 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to <http://unlicense.org/>. diff --git a/lib/debug/readme.md b/lib/debug/readme.md new file mode 100644 index 0000000..602496a --- /dev/null +++ b/lib/debug/readme.md @@ -0,0 +1,6 @@ +# Ivy Debug Theme + +[1]: https://github.com/dmulholl/ivy + +This [Ivy][1] theme is designed as a debugging tool, useful when building themes or plugins. +It displays all the page data available for use in template files. diff --git a/lib/debug/resources/debug.css b/lib/debug/resources/debug.css new file mode 100644 index 0000000..012363c --- /dev/null +++ b/lib/debug/resources/debug.css @@ -0,0 +1,109 @@ +html { + font-size: 100%; +} + +body { + margin: 0 auto; + padding: 50px; + font-family: "Georgia", serif; + font-size: 14px; + line-height: 1.5; + color: #333; + background-color: #f8f8f8; +} + +#wrap { + max-width: 800px; + background-color: #fff; + padding: 80px; + margin: 0 auto; + border: 1px solid #ccc; +} + +h1 { + margin: 0 0 40px; + padding: 0; + font-weight: normal; + line-height: 1.2; + padding: 16px 0; + font-size: 24px; + border-top: 1px solid #ccc; + border-bottom: 1px solid #ccc; +} + +h1 a { + float: right; + text-decoration: none; + padding-right: 20px; +} + +ul, ol { + margin: 36px 0px; + padding: 0 0 0 16px; +} + +ul ul, ol ol, ul ol, ol ul { + margin: 0 8px; +} + +li { + margin: 0; + padding: 0; +} + +pre { + font-size: 13px; + font-family: monospace; + color: #222; + background-color: #f8f8f8; + margin: 32px 0; + padding: 18px 24px; + border-top: 1px solid #ccc; + border-bottom: 1px solid #ccc; + overflow: auto; +} + +.button { + background-color: #eee; + cursor: pointer; + padding: 20px; + width: 100%; + border: none; + text-align: left; + outline: none; + font-size: 16px; + font-family: "Georgia", serif; + margin-top: 5px; +} + +.active, .button:hover { + background-color: #ccc; +} + +.menu { + padding: 0 20px; +} + +.panel { + padding: 0 20px; + background-color: white; + max-height: 0; + overflow: hidden; + transition: max-height 0.2s ease-out; +} + +.panel.last pre { + margin-bottom: 0; +} + +.button:after { + content: '\02795'; /* Unicode character for "plus" sign (+) */ + font-size: 10px; + color: red; + float: right; + margin-left: 5px; +} + +.active:after { + content: "\2796"; /* Unicode character for "minus" sign (-) */ +} diff --git a/lib/debug/resources/pygments.css b/lib/debug/resources/pygments.css new file mode 100644 index 0000000..3679d29 --- /dev/null +++ b/lib/debug/resources/pygments.css @@ -0,0 +1,73 @@ +/* + Syntax highlighting styles for Pygmentized code samples. +*/ + +pre .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +pre .c { color: #8f5902; font-style: italic } /* Comment */ +pre .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +pre .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +pre .cp { color: #8f5902 } /* Comment.Preproc */ +pre .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +pre .g { color: #222222 } /* Generic */ +pre .gd { color: #a40000 } /* Generic.Deleted */ +pre .ge { color: #222222; font-style: italic } /* Generic.Emph */ +pre .gr { color: #ef2929 } /* Generic.Error */ +pre .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +pre .gi { color: #00A000 } /* Generic.Inserted */ +pre .go { color: #222222; font-style: italic } /* Generic.Output */ +pre .gp { color: #8f5902 } /* Generic.Prompt */ +pre .gs { color: #222222; font-weight: bold } /* Generic.Strong */ +pre .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +pre .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +pre .il { color: #000088 } /* Literal.Number.Integer.Long */ +pre .k { color: #204a87; font-weight: bold } /* Keyword */ +pre .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */ +pre .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */ +pre .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */ +pre .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */ +pre .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */ +pre .kt { color: #204a87; font-weight: bold } /* Keyword.Type */ +pre .l { color: #222222 } /* Literal */ +pre .ld { color: #222222 } /* Literal.Date */ +pre .m { color: #000088 } /* Literal.Number */ +pre .mf { color: #000088 } /* Literal.Number.Float */ +pre .mh { color: #000088 } /* Literal.Number.Hex */ +pre .mi { color: #000088 } /* Literal.Number.Integer */ +pre .mo { color: #000088 } /* Literal.Number.Oct */ +pre .n { color: #222222 } /* Name */ +pre .na { color: #8f5902 } /* Name.Attribute */ +pre .nb { color: #204a87 } /* Name.Builtin */ +pre .nc { color: #222222 } /* Name.Class */ +pre .no { color: #222222 } /* Name.Constant */ +pre .nd { color: #000088 } /* Name.Decorator */ +pre .ni { color: #ce5c00 } /* Name.Entity */ +pre .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +pre .nf { color: #222222 } /* Name.Function */ +pre .nl { color: #f57900 } /* Name.Label */ +pre .nn { color: #222222 } /* Name.Namespace */ +pre .nt { color: #204a87; font-weight: bold } /* Name.Tag */ +pre .nv { color: #222222 } /* Name.Variable */ +pre .nx { color: #222222 } /* Name.Other */ +pre .o { color: #000088 } /* Operator */ +pre .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +pre .p { color: #222222 } /* Punctuation */ +pre .py { color: #222222 } /* Name.Property */ +pre .s { color: #880000 } /* Literal.String */ +pre .s1 { color: #880000 } /* Literal.String.Single */ +pre .s2 { color: #880000 } /* Literal.String.Double */ +pre .sb { color: #880000 } /* Literal.String.Backtick */ +pre .sc { color: #880000 } /* Literal.String.Char */ +pre .sd { color: #880000; font-style: italic } /* Literal.String.Doc */ +pre .se { color: #880000 } /* Literal.String.Escape */ +pre .sh { color: #880000 } /* Literal.String.Heredoc */ +pre .si { color: #880000 } /* Literal.String.Interpol */ +pre .sr { color: #880000 } /* Literal.String.Regex */ +pre .ss { color: #880000 } /* Literal.String.Symbol */ +pre .sx { color: #880000 } /* Literal.String.Other */ +pre .vc { color: #222222 } /* Name.Variable.Class */ +pre .vg { color: #222222 } /* Name.Variable.Global */ +pre .vi { color: #222222 } /* Name.Variable.Instance */ +pre .x { color: #222222 } /* Other */ + +pre .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ +pre .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ diff --git a/lib/debug/templates/node.ibis b/lib/debug/templates/node.ibis new file mode 100644 index 0000000..6bb4221 --- /dev/null +++ b/lib/debug/templates/node.ibis @@ -0,0 +1,77 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <title>Debugging: {{ site.title || "Mystery Site" }}</title> + <link rel="stylesheet" href="@root/debug.css"> + <link rel="stylesheet" href="@root/pygments.css"> + </head> + <body> + <div id="wrap"> + <h1> + {$ node $} + {% if node.parent %} + <a href="{$ node.parent.url $}">↑</a> + {% endif %} + </h1> + + {% if inc.menu %} + <div class="menu"> + {{ inc.menu }} + </div> + {% endif %} + + <button class="button">Automenu</button> + <div class="panel"> + {{ automenu }} + </div> + + <button class="button">Node Children</button> + <div class="panel"> + <ul> + {% for child in node.children %} + <li><a href="{$ child.url $}">{$ child $}</a></li> + {% empty %} + <li>None.</li> + {% endfor %} + </ul> + </div> + + <button class="button">Node Meta</button> + <div class="panel"> + <pre>{{ node.meta|pprint|pygmentize('python') }}</pre> + </div> + + <button class="button">Node Text</button> + <div class="panel"> + <pre>{{ node.text.strip()|escape }}</pre> + </div> + + <button class="button">Node HTML</button> + <div class="panel"> + <pre>{{ node.html|escape }}</pre> + </div> + + <button class="button">Page Data</button> + <div class="panel last"> + <pre>{{ context.data.stack|index(2)|pprint|pygmentize('python') }}</pre> + </div> + </div> + + <script> + var buttons = document.getElementsByClassName("button"); + for (let i = 0; i < buttons.length; i++) { + buttons[i].addEventListener("click", function() { + this.classList.toggle("active"); + var panel = this.nextElementSibling; + if (panel.style.maxHeight) { + panel.style.maxHeight = null; + } else { + panel.style.maxHeight = panel.scrollHeight + "px"; + } + }); + } + </script> + + </body> +</html> diff --git a/lib/graphite/license.txt b/lib/graphite/license.txt new file mode 100644 index 0000000..53261fe --- /dev/null +++ b/lib/graphite/license.txt @@ -0,0 +1,24 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to <http://unlicense.org/>. diff --git a/lib/graphite/readme.md b/lib/graphite/readme.md new file mode 100644 index 0000000..0f131cb --- /dev/null +++ b/lib/graphite/readme.md @@ -0,0 +1,37 @@ +# Graphite + +[1]: https://github.com/dmulholl/ivy +[2]: https://fonts.google.com/specimen/Crimson+Text + +A simple [Ivy][1] theme designed for generating project documentation. + +This theme will display the following attributes from the site's `config.py` file in the site header: + +* `title` +* `tagline` + +It supports the following includes: + +* `menu` + + This file will be used to construct the theme's main menu. It should contain + a list of links, optionally with nested sub-lists. + +* `head` + + If a `head.html` file is present in the includes folder its content will be + included at the end of each page's `<head>` section. This file can be used + to add custom CSS or JavaScript to a site without directly editing the + theme's template files. + +* `foot` + + If a `foot.html` file is present in the includes folder its content will + be included at the end of each page's `<body>` section. This file can be + used to add custom JavaScript to a site without directly editing the + theme's template files. + +This theme is distributed under the following license: + +* All code has been placed in the public domain. +* The bundled [Crimson Text][2] font is distributed under the SIL Open Font License. diff --git a/lib/graphite/resources/assets/fonts.css b/lib/graphite/resources/assets/fonts.css new file mode 100644 index 0000000..33f9cfa --- /dev/null +++ b/lib/graphite/resources/assets/fonts.css @@ -0,0 +1,72 @@ +/** + * ------------------------------------------------------------------------- + * Google fonts served locally. + * ------------------------------------------------------------------------- + */ + +@font-face { + font-family: 'Crimson Text'; + font-style: normal; + font-weight: 400; + src: local('Crimson Text Regular'), + local('CrimsonText-Regular'), + url(fonts/CrimsonText-Regular.woff2) format('woff2'), + url(fonts/CrimsonText-Regular.ttf) format('truetype'); +} + +@font-face { + font-family: 'Crimson Text'; + font-style: italic; + font-weight: 400; + src: local('Crimson Text Italic'), + local('CrimsonText-Italic'), + url(fonts/CrimsonText-Italic.woff2) format('woff2'), + url(fonts/CrimsonText-Italic.ttf) format('truetype'); +} + +@font-face { + font-family: 'Crimson Text'; + font-style: normal; + font-weight: 700; + src: local('Crimson Text Bold'), + local('CrimsonText-Bold'), + url(fonts/CrimsonText-Bold.woff2) format('woff2'), + url(fonts/CrimsonText-Bold.ttf) format('truetype'); +} + +/* + The fonts below are packaged with the theme and can be uncommented + if needed. + */ + +/* +@font-face { + font-family: 'Crimson Text'; + font-style: italic; + font-weight: 700; + src: local('Crimson Text Bold Italic'), + local('CrimsonText-BoldItalic'), + url(fonts/CrimsonText-BoldItalic.woff2) format('woff2'), + url(fonts/CrimsonText-BoldItalic.ttf) format('truetype'); +} + +@font-face { + font-family: 'Crimson Text'; + font-style: normal; + font-weight: 600; + src: local('Crimson Text SemiBold'), + local('CrimsonText-SemiBold'), + url(fonts/CrimsonText-SemiBold.woff2) format('woff2'), + url(fonts/CrimsonText-SemiBold.ttf) format('truetype'); +} + +@font-face { + font-family: 'Crimson Text'; + font-style: italic; + font-weight: 600; + src: local('Crimson Text SemiBold Italic'), + local('CrimsonText-SemiBoldItalic'), + url(fonts/CrimsonText-SemiBoldItalic.woff2) format('woff2'), + url(fonts/CrimsonText-SemiBoldItalic.ttf) format('truetype'); +} +*/ diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-Bold.ttf b/lib/graphite/resources/assets/fonts/CrimsonText-Bold.ttf Binary files differnew file mode 100644 index 0000000..7e2772c --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-Bold.ttf diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-Bold.woff2 b/lib/graphite/resources/assets/fonts/CrimsonText-Bold.woff2 Binary files differnew file mode 100644 index 0000000..d691718 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-Bold.woff2 diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-BoldItalic.ttf b/lib/graphite/resources/assets/fonts/CrimsonText-BoldItalic.ttf Binary files differnew file mode 100644 index 0000000..b71ae01 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-BoldItalic.ttf diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-BoldItalic.woff2 b/lib/graphite/resources/assets/fonts/CrimsonText-BoldItalic.woff2 Binary files differnew file mode 100644 index 0000000..abc06a5 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-BoldItalic.woff2 diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-Italic.ttf b/lib/graphite/resources/assets/fonts/CrimsonText-Italic.ttf Binary files differnew file mode 100644 index 0000000..7d86331 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-Italic.ttf diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-Italic.woff2 b/lib/graphite/resources/assets/fonts/CrimsonText-Italic.woff2 Binary files differnew file mode 100644 index 0000000..8c1c635 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-Italic.woff2 diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-Regular.ttf b/lib/graphite/resources/assets/fonts/CrimsonText-Regular.ttf Binary files differnew file mode 100644 index 0000000..4dda4ed --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-Regular.ttf diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-Regular.woff2 b/lib/graphite/resources/assets/fonts/CrimsonText-Regular.woff2 Binary files differnew file mode 100644 index 0000000..e9ce880 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-Regular.woff2 diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-SemiBold.ttf b/lib/graphite/resources/assets/fonts/CrimsonText-SemiBold.ttf Binary files differnew file mode 100644 index 0000000..5e24039 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-SemiBold.ttf diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-SemiBold.woff2 b/lib/graphite/resources/assets/fonts/CrimsonText-SemiBold.woff2 Binary files differnew file mode 100644 index 0000000..91bbb5d --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-SemiBold.woff2 diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-SemiBoldItalic.ttf b/lib/graphite/resources/assets/fonts/CrimsonText-SemiBoldItalic.ttf Binary files differnew file mode 100644 index 0000000..50b3f44 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-SemiBoldItalic.ttf diff --git a/lib/graphite/resources/assets/fonts/CrimsonText-SemiBoldItalic.woff2 b/lib/graphite/resources/assets/fonts/CrimsonText-SemiBoldItalic.woff2 Binary files differnew file mode 100644 index 0000000..077f178 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/CrimsonText-SemiBoldItalic.woff2 diff --git a/lib/graphite/resources/assets/fonts/OFL.txt b/lib/graphite/resources/assets/fonts/OFL.txt new file mode 100644 index 0000000..ed4fea1 --- /dev/null +++ b/lib/graphite/resources/assets/fonts/OFL.txt @@ -0,0 +1,93 @@ +Copyright (c) 2010, Sebastian Kosch ([email protected]), +with Reserved Font Name "Crimson" and "Crimson Text". +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/lib/graphite/resources/assets/graphite.css b/lib/graphite/resources/assets/graphite.css new file mode 100644 index 0000000..e1b5a8c --- /dev/null +++ b/lib/graphite/resources/assets/graphite.css @@ -0,0 +1,685 @@ +/** + * ------------------------------------------------------------------------- + * Micro Reset + * ------------------------------------------------------------------------- + */ + +*, *:before, *:after { + box-sizing: inherit; +} + +html { + box-sizing: border-box; + font-size: 100%; + -webkit-text-size-adjust: none; + text-size-adjust: none; +} + +body { + margin: 0; + padding: 0; +} + +form, fieldset, legend { + margin: 0; + padding: 0; +} + +button, input, select, textarea, label { + margin: 0; + padding: 0; + font-family: inherit; + font-size: inherit; +} + +img { + border: 0; + max-width: 100%; +} + +/** + * ------------------------------------------------------------------------- + * Typography + * ------------------------------------------------------------------------- + */ + +body { + font-size: 17px; + color: black; + font-family: 'Crimson Text', Georgia, serif; + line-height: 1.75; +} + +h1 { + padding: 0; + margin: 80px 0 30px; + line-height: 1.25; + text-align: center; + font-size: 32px; + font-weight: normal; +} + +h2 { + padding: 0; + margin: 80px 0 30px; + line-height: 1.25; + text-align: center; + font-size: 22px; + font-weight: bold; +} + +h2.underline { + padding: 0; + margin: 80px 0 35px; + line-height: 1.25; + text-align: left; + font-size: 22px; + font-weight: bold; + padding-bottom: 5px; + border-bottom: 1px solid #ccc; +} + +h3, h4, h5, h6 { + padding: 0; + margin: 80px 0 30px; + line-height: 1.25; + text-align: left; + font-size: 19px; + font-weight: bold; +} + +p { + margin: 25px 0; + padding: 0; + overflow-wrap: break-word; +} + +blockquote { + margin: 40px 0px; + padding: 0 20px; + border-left: 3px solid #ddd; + font-style: italic; +} + +.blockquote-caption { + margin: -10px 20px 40px; + text-align: right; +} + +abbr[title] { + border-bottom: 1px dotted; + cursor: help; +} + +sup, sub { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + bottom: 1.5ex; + padding: 0 0.5ex; +} + +sub { + top: .5ex; +} + +/** + * Code + */ + +pre, code { + font-size: 13px; + font-family: Consolas, monospace; +} + +code { + margin: 0 2px; + padding: 1px 5px; + white-space: nowrap; + border: 1px solid #e8e8e8; + border-radius: 3px; + background-color: #f8f8f8; +} + +pre { + margin: 40px 0; + padding: 16px 20px; + border-top: 1px dotted #bbb; + border-bottom: 1px dotted #bbb; + background-color: #f8f8f8; + overflow: auto; + line-height: 1.4; +} + +h1 code { + font-size: 28px; +} + +/** + * Lists + */ + +ul, ol { + margin: 35px 0; + padding: 0 0 0 20px; +} + +ul ul, ol ol, ul ol, ol ul { + margin: 10px 10px; +} + +li { + margin: 4px 0; + padding: 0; +} + +dl { + margin: 40px 0; + padding: 0; +} + +dt { + margin: 45px 0 25px; + padding: 0; + font-weight: bold; +} + +dd { + margin: 25px 0px; + padding: 0 25px; + border-left: 1px solid #ddd; +} + +/** + * Links + */ + +a { + color: black; + text-decoration: none; + padding-bottom: 2px; + border-bottom: 1px solid; +} + +sup a { + border-bottom: none; +} + +/** + * Miscellanea + */ + +hr { + display: block; + height: 1px; + border: 0; + border-top: 1px solid; + margin: 60px auto; + padding: 0; + max-width: 300px; +} + +img { + margin: 40px auto; + display: block; +} + +/** + * ------------------------------------------------------------------------- + * Layout + * ------------------------------------------------------------------------- + */ + +body { + width: 960px; + margin: 0 auto; + padding: 40px 0; +} + +.masthead { + width: 360px; + padding: 20px 50px; + float: left; +} + +.main { + width: 600px; + padding: 32px 50px 40px 50px; + margin-left: 360px; + border-left: 3px solid black; + min-height: calc(100vh - 80px); +} + +/** + * ------------------------------------------------------------------------- + * Masthead + * ------------------------------------------------------------------------- + */ + +.masthead h1 { + margin-top: 0; + margin-bottom: 34px; + padding: 0; + text-align: right; + font-size: 46px; + line-height: 58px; +} + +.masthead h1 a { + border-bottom: none; +} + +.masthead .tagline { + font-style: italic; + text-align: right; +} + +.masthead .version { + font-style: italic; + text-align: right; +} + +.masthead .menu { + margin-right: 20px; + direction: rtl; +} + +.masthead .menu a { + direction: ltr; +} + +.masthead .menu ul ul { + list-style: none; + margin-left: 10px; + margin-right: 10px; +} + +.masthead .menu li li::before { + content: "•\00a\000a0\00a0" +} + +#menu-check { + display: none; +} + +#menu-label { + display: none; +} + +/** + * ------------------------------------------------------------------------- + * Main + * ------------------------------------------------------------------------- + */ + +.main .title h1 { + margin-top: 0; + margin-bottom: 40px; +} + +.main .title .subtitle { + font-style: italic; + text-align: center; +} + +.main .title hr { + margin: 50px auto 60px; +} + +.main > :last-child { + margin-bottom: 0; +} + +/** + * Info Boxes + */ + +.infobox, .alertbox { + margin: 40px 20px; + border: 1px solid; + padding: 0 25px; + border-radius: 3px; + border-color: #bbb; + background-color: #f8f8f8; +} + +.infobox.blue, .alertbox.info { + border-color: #bac6d3; + background-color: #e2eef9; +} + +.infobox.yellow, .alertbox.warning { + border-color: #dfd8c2; + background-color: #fff9ea; +} + +.infobox.red, .alertbox.error { + border-color: #d2b2b2; + background-color: #fcdede; +} + +.infobox.green, .alertbox.success { + border-color: #B2C2AB; + background-color: #DEF2D6; +} + +/** + * Footnotes + */ + + .footnote a::before { + content: "["; + } + + .footnote a::after { + content: "]"; + } + + .footnote a { + border: none; + } + + .footnotes dt { + display: table-cell; + width: 30px; + text-align: right; + font-weight: normal; + } + + .footnotes dt a { + padding: 0; + border: none; + } + + .footnotes dt a::before { + content: "["; + } + + .footnotes dt a::after { + content: "]"; + } + + .footnotes dd { + display: table-cell; + padding-left: 20px; + padding-right: 0px; + border: none + } + + .footnotes dd :first-child { + margin-top: 0; + } + + .footnotes div:last-child dd :last-child { + margin-bottom: 0; + } + + .footnotes pre { + margin: 30px 0; + } + +/** + * Tables + */ + +table { + font-size: 16px; + border-collapse: collapse; + border-spacing: 0; + margin: 50px 0px; + width: 100%; +} + +thead, tfoot { + background-color: #f8f8f8; +} + +th, td { + border: 1px solid #ccc; + padding: 14px 20px; + text-align: left; +} + +/** + * Utility Styles + */ + +.small { + font-size: 16px; +} + +.left { + text-align: left; +} + +.right { + text-align: right; +} + +.center { + text-align: center; +} + +.justify { + text-align: justify; +} + +.bold { + font-weight: bold; +} + +.italic { + font-style: italic; +} + +.indent { + padding-left: 30px; + padding-right: 30px; +} + +.unselectable { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +/** + * Custom Classes + */ + +body.extra-deflist-vspace dt { + margin-top: 80px; +} + +/** + * ------------------------------------------------------------------------- + * Media Queries + * ------------------------------------------------------------------------- + */ + +/* Tablet screens and smaller. */ + +@media screen and (max-width: 960px) { + + body { + width: auto; + max-width: 680px; + padding-top: 60px; + } + + .masthead { + width: auto; + float: none; + padding: 60px 20px 60px 20px; + text-align: center; + margin-left: 40px; + margin-right: 40px; + border-top: 3px solid black; + border-bottom: 3px solid black; + } + + .main { + width: auto; + padding: 40px 40px; + margin-left: 0; + border-left: none; + min-height: auto; + } + + .masthead h1 { + text-align: center; + } + + .masthead .tagline { + text-align: center; + max-width: 450px; + margin-left: auto; + margin-right: auto; + display: none; + } + + .homepage .masthead .tagline { + display: block; + } + + .masthead .version { + text-align: center; + } + + .masthead .menu { + direction: ltr; + max-width: 300px; + margin-left: auto; + margin-right: auto; + } + + .masthead .menu ul { + text-align: left; + margin: 0; + padding: 0; + } + + .masthead .menu ul ul { + margin: 0; + } + + .masthead .menu li { + border-bottom: 1px solid; + list-style: none; + margin: 0; + padding: 0; + } + + .masthead .menu li:first-child { + border-top: 1px solid; + } + + .masthead .menu li li:last-child { + border-bottom: none; + } + + .masthead .menu a { + display: block; + padding: 15px 20px; + border-bottom: none; + } + + .masthead .menu li li a { + padding-left: 30px; + } + + .masthead .menu li li::before { + content: none; + } + + .masthead .menu li li a::before { + content: "•\00a0\00a0\00a0"; + } + + #menu-label { + display: inline-block; + padding: 0 20px; + height: 50px; + border: 1px solid #ddd; + cursor: pointer; + line-height: 50px; + color: #333; + font-size: 20px; + margin-top: 10px; + } + + #menu-label:hover, #menu-label:focus { + border: 1px solid #888; + } + + #menu-label .icon { + padding-right: 8px; + width: 30px; + } + + #menu-check ~ label .close-icon { + display: none; + } + + #menu-check ~ label .open-icon { + display: inline-block; + } + + #menu-check:checked ~ label .close-icon { + display: inline-block; + } + + #menu-check:checked ~ label .open-icon { + display: none; + } + + #menu-check ~ ul { + display: none; + } + + #menu-check:checked ~ ul { + display: block; + margin-top: 50px; + margin-bottom: 0; + } +} + +/* Landscape phone screens and smaller. */ + +@media screen and (max-width: 720px) { +} + +/* Portrait phone screens. */ + +@media screen and (max-width: 480px) { + + body { + font-size: 16px; + padding-top: 40px; + } + + h1 { + font-size: 28px; + } + + h2 { + font-size: 18px; + } + + h3, h4, h5, h6 { + font-size: 16px; + } + + pre, code { + font-size: 12px; + } + + .small { + font-size: 15px; + } +} diff --git a/lib/graphite/resources/assets/pygments.css b/lib/graphite/resources/assets/pygments.css new file mode 100644 index 0000000..2df111c --- /dev/null +++ b/lib/graphite/resources/assets/pygments.css @@ -0,0 +1,76 @@ +/** + * ------------------------------------------------------------------------- + * Pygments Theme + * ------------------------------------------------------------------------- + */ + +pre .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +pre .c { color: #8f5902 } /* Comment */ +pre .c1 { color: #8f5902 } /* Comment.Single */ +pre .cm { color: #8f5902 } /* Comment.Multiline */ +pre .cp { color: #540e8a; font-weight: bold } /* Comment.Preproc */ +pre .cs { color: #8f5902 } /* Comment.Special */ +pre .g { color: #222222 } /* Generic */ +pre .gd { color: #a40000 } /* Generic.Deleted */ +pre .ge { color: #222222 } /* Generic.Emph */ +pre .gr { color: #ef2929 } /* Generic.Error */ +pre .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +pre .gi { color: #00A000 } /* Generic.Inserted */ +pre .go { color: #222222 } /* Generic.Output */ +pre .gp { color: #8f5902 } /* Generic.Prompt */ +pre .gs { color: #222222; font-weight: bold } /* Generic.Strong */ +pre .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +pre .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +pre .il { color: #000088 } /* Literal.Number.Integer.Long */ +pre .k { color: #204a87; font-weight: bold } /* Keyword */ +pre .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */ +pre .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */ +pre .kn { color: #540e8a; font-weight: bold } /* Keyword.Namespace */ +pre .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */ +pre .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */ +pre .kt { color: #204a87; font-weight: bold } /* Keyword.Type */ +pre .l { color: #222222 } /* Literal */ +pre .ld { color: #222222 } /* Literal.Date */ +pre .m { color: #000088 } /* Literal.Number */ +pre .mf { color: #000088 } /* Literal.Number.Float */ +pre .mh { color: #000088 } /* Literal.Number.Hex */ +pre .mi { color: #000088 } /* Literal.Number.Integer */ +pre .mo { color: #000088 } /* Literal.Number.Oct */ +pre .mb { color: #000088 } /* Literal.Number.Bin */ +pre .n { color: #222222 } /* Name */ +pre .na { color: #8f5902 } /* Name.Attribute */ +pre .nb { color: #204a87 } /* Name.Builtin */ +pre .nc { color: #222222 } /* Name.Class */ +pre .no { color: #222222 } /* Name.Constant */ +pre .nd { color: #000088 } /* Name.Decorator */ +pre .ni { color: #ce5c00 } /* Name.Entity */ +pre .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +pre .nf { color: #222222 } /* Name.Function */ +pre .nl { color: #880000 } /* Name.Label */ +pre .nn { color: #222222 } /* Name.Namespace */ +pre .nt { color: #204a87; font-weight: bold } /* Name.Tag */ +pre .nv { color: #222222 } /* Name.Variable */ +pre .nx { color: #222222 } /* Name.Other */ +pre .o { color: #000088 } /* Operator */ +pre .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +pre .p { color: #222222 } /* Punctuation */ +pre .py { color: #222222 } /* Name.Property */ +pre .s { color: #880000 } /* Literal.String */ +pre .s1 { color: #880000 } /* Literal.String.Single */ +pre .s2 { color: #880000 } /* Literal.String.Double */ +pre .sb { color: #880000 } /* Literal.String.Backtick */ +pre .sc { color: #880000 } /* Literal.String.Char */ +pre .sd { color: #880000 } /* Literal.String.Doc */ +pre .se { color: #880000 } /* Literal.String.Escape */ +pre .sh { color: #880000 } /* Literal.String.Heredoc */ +pre .si { color: #880000 } /* Literal.String.Interpol */ +pre .sr { color: #880000 } /* Literal.String.Regex */ +pre .ss { color: #880000 } /* Literal.String.Symbol */ +pre .sx { color: #880000 } /* Literal.String.Other */ +pre .vc { color: #222222 } /* Name.Variable.Class */ +pre .vg { color: #222222 } /* Name.Variable.Global */ +pre .vi { color: #222222 } /* Name.Variable.Instance */ +pre .x { color: #222222 } /* Other */ + +pre .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ +pre .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ diff --git a/lib/graphite/templates/node.ibis b/lib/graphite/templates/node.ibis new file mode 100644 index 0000000..bf0a85a --- /dev/null +++ b/lib/graphite/templates/node.ibis @@ -0,0 +1,46 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <title>{{ node.meta_title || node.title || site.title }}</title> + <link rel="stylesheet" href="@root/assets/fonts.css"> + <link rel="stylesheet" href="@root/assets/graphite.css"> + <link rel="stylesheet" href="@root/assets/pygments.css"> + {% if node.meta_description %} + <meta name="description" content="{$ node.meta_description.strip() $}"> + {% endif %} + {{ inc.head }} + </head> + <body class="{$ classes|join(' ') $}"> + <header class="masthead"> + <h1><a href="@root/">{{ site.title || "Site Title" }}</a></h1> + {% if site.tagline %} + <p class="tagline">{{ site.tagline.strip() }}</p> + {% endif %} + {% if site.version %} + <p class="version">{{ site.version.strip() }}</p> + {% endif %} + <nav class="menu"> + <input id="menu-check" type="checkbox"/> + <label id="menu-label" for="menu-check" class="unselectable"> + <span class="icon close-icon">✕</span> + <span class="icon open-icon">☰</span> + <span class="text">Menu</span> + </label> + {{ inc.menu || automenu }} + </nav> + </header> + <article class="main"> + <header class="title"> + <h1>{{ node.title }}</h1> + {% if node.subtitle %} + <p class="subtitle">{{ node.subtitle }}</p> + {% endif %} + <hr> + </header> + {{ node.html }} + </article> + {{ inc.foot }} + </body> +</html> diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ee3d20b --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +ivy==6.0.4 diff --git a/src/about.md b/src/about.md new file mode 100644 index 0000000..5f8b4ca --- /dev/null +++ b/src/about.md @@ -0,0 +1,15 @@ +--- +title: About +--- + +## Authors + +- [Fuwn](https://github.com/Fuwn) <[[email protected]](mailto:[email protected])> + +## Acknowledgements + +This website was built using [Ivy](https://github.com/dmulholl/ivy). + +## License + +[GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) diff --git a/src/index.md b/src/index.md new file mode 100644 index 0000000..d296a40 --- /dev/null +++ b/src/index.md @@ -0,0 +1,6 @@ +--- +title: Divina +subtitle: 🎀 A modern build system for assembly +--- + +[Divina](https://github.com/divinaland/Divina) is a modern build system for assembly in heavy development. |