\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n.\n",
+ "html": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n
\nCopyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/\nEveryone is permitted to copy and distribute verbatim copies\nof this license document, but changing it is not allowed.
\n Preamble\n
\nThe GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.
\nThe licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.
\nWhen we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.
\nDevelopers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.
\nA secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.
\nThe GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.
\nAn older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.
\nThe precise terms and conditions for copying, distribution and\nmodification follow.
\n TERMS AND CONDITIONS\n
\n0. Definitions.
\n\"This License\" refers to version 3 of the GNU Affero General Public License.
\n\"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.
\n\"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.
\nTo \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.
\nA \"covered work\" means either the unmodified Program or a work based\non the Program.
\nTo \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.
\nTo \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.
\nAn interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.
\n\n- Source Code.
\n
\nThe \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.
\nA \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.
\nThe \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.
\nThe \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.
\nThe Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.
\nThe Corresponding Source for a work in source code form is that\nsame work.
\n\n- Basic Permissions.
\n
\nAll rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.
\nYou may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.
\nConveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.
\n\n- Protecting Users' Legal Rights From Anti-Circumvention Law.
\n
\nNo covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.
\nWhen you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.
\n\n- Conveying Verbatim Copies.
\n
\nYou may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.
\nYou may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.
\n\n- Conveying Modified Source Versions.
\n
\nYou may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:
\na) The work must carry prominent notices stating that you modified\nit, and giving a relevant date.\n\nb) The work must carry prominent notices stating that it is\nreleased under this License and any conditions added under section\n7. This requirement modifies the requirement in section 4 to\n\"keep intact all notices\".\n\nc) You must license the entire work, as a whole, under this\nLicense to anyone who comes into possession of a copy. This\nLicense will therefore apply, along with any applicable section 7\nadditional terms, to the whole of the work, and all its parts,\nregardless of how they are packaged. This License gives no\npermission to license the work in any other way, but it does not\ninvalidate such permission if you have separately received it.\n\nd) If the work has interactive user interfaces, each must display\nAppropriate Legal Notices; however, if the Program has interactive\ninterfaces that do not display Appropriate Legal Notices, your\nwork need not make them do so.\n
\nA compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.
\n\n- Conveying Non-Source Forms.
\n
\nYou may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:
\na) Convey the object code in, or embodied in, a physical product\n(including a physical distribution medium), accompanied by the\nCorresponding Source fixed on a durable physical medium\ncustomarily used for software interchange.\n\nb) Convey the object code in, or embodied in, a physical product\n(including a physical distribution medium), accompanied by a\nwritten offer, valid for at least three years and valid for as\nlong as you offer spare parts or customer support for that product\nmodel, to give anyone who possesses the object code either (1) a\ncopy of the Corresponding Source for all the software in the\nproduct that is covered by this License, on a durable physical\nmedium customarily used for software interchange, for a price no\nmore than your reasonable cost of physically performing this\nconveying of source, or (2) access to copy the\nCorresponding Source from a network server at no charge.\n\nc) Convey individual copies of the object code with a copy of the\nwritten offer to provide the Corresponding Source. This\nalternative is allowed only occasionally and noncommercially, and\nonly if you received the object code with such an offer, in accord\nwith subsection 6b.\n\nd) Convey the object code by offering access from a designated\nplace (gratis or for a charge), and offer equivalent access to the\nCorresponding Source in the same way through the same place at no\nfurther charge. You need not require recipients to copy the\nCorresponding Source along with the object code. If the place to\ncopy the object code is a network server, the Corresponding Source\nmay be on a different server (operated by you or a third party)\nthat supports equivalent copying facilities, provided you maintain\nclear directions next to the object code saying where to find the\nCorresponding Source. Regardless of what server hosts the\nCorresponding Source, you remain obligated to ensure that it is\navailable for as long as needed to satisfy these requirements.\n\ne) Convey the object code using peer-to-peer transmission, provided\nyou inform other peers where the object code and Corresponding\nSource of the work are being offered to the general public at no\ncharge under subsection 6d.\n
\nA separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.
\nA \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.
\n\"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.
\nIf you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).
\nThe requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.
\nCorresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.
\n\n- Additional Terms.
\n
\n\"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.
\nWhen you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.
\nNotwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:
\na) Disclaiming warranty or limiting liability differently from the\nterms of sections 15 and 16 of this License; or\n\nb) Requiring preservation of specified reasonable legal notices or\nauthor attributions in that material or in the Appropriate Legal\nNotices displayed by works containing it; or\n\nc) Prohibiting misrepresentation of the origin of that material, or\nrequiring that modified versions of such material be marked in\nreasonable ways as different from the original version; or\n\nd) Limiting the use for publicity purposes of names of licensors or\nauthors of the material; or\n\ne) Declining to grant rights under trademark law for use of some\ntrade names, trademarks, or service marks; or\n\nf) Requiring indemnification of licensors and authors of that\nmaterial by anyone who conveys the material (or modified versions of\nit) with contractual assumptions of liability to the recipient, for\nany liability that these contractual assumptions directly impose on\nthose licensors and authors.\n
\nAll other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.
\nIf you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.
\nAdditional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.
\n\n- Termination.
\n
\nYou may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).
\nHowever, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.
\nMoreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.
\nTermination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.
\n\n- Acceptance Not Required for Having Copies.
\n
\nYou are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.
\n\n- Automatic Licensing of Downstream Recipients.
\n
\nEach time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.
\nAn \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.
\nYou may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.
\n\n- Patents.
\n
\nA \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".
\nA contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.
\nEach contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.
\nIn the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.
\nIf you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.
\nIf, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.
\nA patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.
\nNothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.
\n\n- No Surrender of Others' Freedom.
\n
\nIf conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.
\n\n- Remote Network Interaction; Use with the GNU General Public License.
\n
\nNotwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.
\nNotwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.
\n\n- Revised Versions of this License.
\n
\nThe Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.
\nEach version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.
\nIf the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.
\nLater license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.
\n\n- Disclaimer of Warranty.
\n
\nTHERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.
\n\n- Limitation of Liability.
\n
\nIN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.
\n\n- Interpretation of Sections 15 and 16.
\n
\nIf the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.
\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n
\nIf you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.
\nTo do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.
\n<one line to give the program's name and a brief idea of what it does.>\nCopyright (C) <year> <name of author>\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n
\nAlso add information on how to contact you by electronic and paper mail.
\nIf your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.
\nYou should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\nhttps://www.gnu.org/licenses/.
"
+ },
+ "_id": "Community/License.md",
+ "_raw": {
+ "sourceFilePath": "Community/License.md",
+ "sourceFileName": "License.md",
+ "sourceFileDir": "Community",
+ "contentType": "markdown",
+ "flattenedPath": "Community/License"
+ },
+ "type": "Markdown",
+ "slug": "Community/License",
+ "title": "License"
+}
\ No newline at end of file
diff --git a/apps/web/.contentlayer/generated/Markdown/Extension__CustomTheme.md.json b/apps/web/.contentlayer/generated/Markdown/Extension__CustomTheme.md.json
new file mode 100644
index 000000000..32ac8cba6
--- /dev/null
+++ b/apps/web/.contentlayer/generated/Markdown/Extension__CustomTheme.md.json
@@ -0,0 +1,17 @@
+{
+ "body": {
+ "raw": "# Custom Theme\n\nMarkFlowy supports custom themes, and you can also share your themes with others.\n\n## Develop Environment\n\n- MarkFlowy > 0.7.0\n- nodejs >= 18.x\n- pnpm >= 7.x\n\n## How to make a theme\n\n### 1. Create theme files\n\nYou can fork [MarkFlowy-Theme-Template](https://github.com/MarkFlowy/custom-theme-template) to create your theme.\n\n```bash\npnpm install\n\npnpm run dev\n```\n\n### 2. Edit theme files\n\nOpen MarkFlowy, click `Settings`, you can see `path`, Open this path folder, create `themes` folder in `.markflowy` folder, and then create your theme folder in `themes` folder, e.g. `markflowy-theme-template`.\n\nYou can edit `rollup.config.js` to change the theme build files output.\n\n\n```js\noutput: {\n // change this output file to development\n // e.g. file: '/Users/xxx/.markflowy/themes/markflowy-theme-template/index.js',\n file: pkg.browser,\n format: 'es',\n sourcemap: true,\n entryFileNames: '[name].js',\n},\n```\n\nchange your theme, reload MarkFlowy to see the effect.\n\n\n\n\n",
+ "html": "Custom Theme
\nMarkFlowy supports custom themes, and you can also share your themes with others.
\nDevelop Environment
\n\n- MarkFlowy > 0.7.0
\n- nodejs >= 18.x
\n- pnpm >= 7.x
\n
\nHow to make a theme
\n1. Create theme files
\nYou can fork MarkFlowy-Theme-Template to create your theme.
\npnpm install\n\npnpm run dev\n
\n2. Edit theme files
\nOpen MarkFlowy, click Settings, you can see path, Open this path folder, create themes folder in .markflowy folder, and then create your theme folder in themes folder, e.g. markflowy-theme-template.
\nYou can edit rollup.config.js to change the theme build files output.
\noutput: {\n // change this output file to development\n // e.g. file: '/Users/xxx/.markflowy/themes/markflowy-theme-template/index.js',\n file: pkg.browser,\n format: 'es',\n sourcemap: true,\n entryFileNames: '[name].js',\n},\n
\nchange your theme, reload MarkFlowy to see the effect.
"
+ },
+ "_id": "Extension/CustomTheme.md",
+ "_raw": {
+ "sourceFilePath": "Extension/CustomTheme.md",
+ "sourceFileName": "CustomTheme.md",
+ "sourceFileDir": "Extension",
+ "contentType": "markdown",
+ "flattenedPath": "Extension/CustomTheme"
+ },
+ "type": "Markdown",
+ "slug": "Extension/CustomTheme",
+ "title": "CustomTheme"
+}
\ No newline at end of file
diff --git a/apps/web/.contentlayer/generated/Markdown/_index.json b/apps/web/.contentlayer/generated/Markdown/_index.json
new file mode 100644
index 000000000..e86b003ab
--- /dev/null
+++ b/apps/web/.contentlayer/generated/Markdown/_index.json
@@ -0,0 +1,87 @@
+[
+ {
+ "body": {
+ "raw": "# MarkFlowy\n\n## MarkFlowy is in Alpha\n\nCurrently, MarkFlowy is still in the alpha phase,This means there may be incompatible version updates, and it is recommended to use it when there is data backup available. \n\n## Feature\n\n- **Built-in ChatGpt**. Currently supports one-click export of conversations, making chatgpt your smart assistant.\n- **Super lightweight**. The MarkFlowy is based on tauri and has a volume of less than 10MB and better performance.\n- **High availability**. MarkFlowy uses the remirror editor, which not only provides high scalability, but also has a great editing experience. And, MarkFlowy supports multiple editing modes, such as `source code`, `wysiyg`.\n\n## Download\n\nAvailable for Linux, macOS and Windows.\n\nPlease look [releases page](https://github.com/drl990114/MarkFlowy/releases)\n\n## Why\nAt present, I have used many Markdown applications, but I have not encountered one that is very suitable for me. I have always hoped to have a Markdown editor that is efficient, beautiful, lightweight, data-safe, and can be easily combined with various workflows. This It is also the original intention of doing MarkFlowy.\n\n## Contribute\n\nThe current MarkFlowy is still in its infancy, and there may be some bad experiences or bugs, for which I am sorry. All partners who are interested or encounter usage problems are welcome to submit [issues](https://github.com/drl990114/MarkFlowy/issues/new) or [PR](https://github.com/drl990114/MarkFlowy/compare) to participate in this project.\n\n### How to Contribute\n\nYou can read [CONTRIBUTING](./Community/CONTRIBUTING.md) to know how to start the project and modify the code, Welcome to participate in code contribution.\n\n## Support\n\nMarkFlowy is completely and permanently open source, if you want to support MarkFlowy, you can `star` this project. This will give me great support and help, love you.\n\n## Thanks\n\n- Tauri - A framework for building cross-platform applications that provides MarkFlowy with a solid foundation.\n- React - Web user interface framework.\n- Remirror - The ProseMirror toolkit for React, on which the MarkFlowy editor is based.\n- Rino - Some initialization codes of package/editor come from here.\n- Vite - front-end build tool.\n- Xplorer - Home page theme from xplorer.\n\nAnd, thanks to all the open source projects that MarkFlowy depends on.\n\n",
+ "html": "MarkFlowy
\nMarkFlowy is in Alpha
\nCurrently, MarkFlowy is still in the alpha phase,This means there may be incompatible version updates, and it is recommended to use it when there is data backup available.
\nFeature
\n\n- Built-in ChatGpt. Currently supports one-click export of conversations, making chatgpt your smart assistant.
\n- Super lightweight. The MarkFlowy is based on tauri and has a volume of less than 10MB and better performance.
\n- High availability. MarkFlowy uses the remirror editor, which not only provides high scalability, but also has a great editing experience. And, MarkFlowy supports multiple editing modes, such as
source code, wysiyg. \n
\nDownload
\nAvailable for Linux, macOS and Windows.
\nPlease look releases page
\nWhy
\nAt present, I have used many Markdown applications, but I have not encountered one that is very suitable for me. I have always hoped to have a Markdown editor that is efficient, beautiful, lightweight, data-safe, and can be easily combined with various workflows. This It is also the original intention of doing MarkFlowy.
\nContribute
\nThe current MarkFlowy is still in its infancy, and there may be some bad experiences or bugs, for which I am sorry. All partners who are interested or encounter usage problems are welcome to submit issues or PR to participate in this project.
\nHow to Contribute
\nYou can read CONTRIBUTING to know how to start the project and modify the code, Welcome to participate in code contribution.
\nSupport
\nMarkFlowy is completely and permanently open source, if you want to support MarkFlowy, you can star this project. This will give me great support and help, love you.
\nThanks
\n\n- Tauri - A framework for building cross-platform applications that provides MarkFlowy with a solid foundation.
\n- React - Web user interface framework.
\n- Remirror - The ProseMirror toolkit for React, on which the MarkFlowy editor is based.
\n- Rino - Some initialization codes of package/editor come from here.
\n- Vite - front-end build tool.
\n- Xplorer - Home page theme from xplorer.
\n
\nAnd, thanks to all the open source projects that MarkFlowy depends on.
"
+ },
+ "_id": "intro.md",
+ "_raw": {
+ "sourceFilePath": "intro.md",
+ "sourceFileName": "intro.md",
+ "sourceFileDir": ".",
+ "contentType": "markdown",
+ "flattenedPath": "intro"
+ },
+ "type": "Markdown",
+ "slug": "intro",
+ "title": "intro"
+ },
+ {
+ "body": {
+ "raw": "\n# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our community includes:\n\n- Demonstrating empathy and kindness toward other people\n- Being respectful of differing opinions, viewpoints, and experiences\n- Giving and gracefully accepting constructive feedback\n- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience\n- Focusing on what is best not just for us as individuals, but for the overall community\n\nExamples of unacceptable behavior include:\n\n- The use of sexualized language or imagery, and sexual attention or advances of any kind\n- Trolling, insulting or derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or email address, without their explicit permission\n- Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kimlimjustin@gmail.com. All complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the reporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series of actions.\n\n**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within the community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.\n",
+ "html": "Contributor Covenant Code of Conduct
\nOur Pledge
\nWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
\nWe pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
\nOur Standards
\nExamples of behavior that contributes to a positive environment for our community includes:
\n\n- Demonstrating empathy and kindness toward other people
\n- Being respectful of differing opinions, viewpoints, and experiences
\n- Giving and gracefully accepting constructive feedback
\n- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
\n- Focusing on what is best not just for us as individuals, but for the overall community
\n
\nExamples of unacceptable behavior include:
\n\n- The use of sexualized language or imagery, and sexual attention or advances of any kind
\n- Trolling, insulting or derogatory comments, and personal or political attacks
\n- Public or private harassment
\n- Publishing others' private information, such as a physical or email address, without their explicit permission
\n- Other conduct which could reasonably be considered inappropriate in a professional setting
\n
\nEnforcement Responsibilities
\nCommunity leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
\nCommunity leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
\nScope
\nThis Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
\nEnforcement
\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kimlimjustin@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
\nAll community leaders are obligated to respect the privacy and security of the reporter of any incident.
\nEnforcement Guidelines
\nCommunity leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
\n1. Correction
\nCommunity Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
\nConsequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
\n2. Warning
\nCommunity Impact: A violation through a single incident or series of actions.
\nConsequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
\n3. Temporary Ban
\nCommunity Impact: A serious violation of community standards, including sustained inappropriate behavior.
\nConsequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
\n4. Permanent Ban
\nCommunity Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
\nConsequence: A permanent ban from any sort of public interaction within the community.
\nAttribution
\nThis Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
\nCommunity Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
\nFor answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
"
+ },
+ "_id": "Community/CODE_OF_CONDUCT.md",
+ "_raw": {
+ "sourceFilePath": "Community/CODE_OF_CONDUCT.md",
+ "sourceFileName": "CODE_OF_CONDUCT.md",
+ "sourceFileDir": "Community",
+ "contentType": "markdown",
+ "flattenedPath": "Community/CODE_OF_CONDUCT"
+ },
+ "type": "Markdown",
+ "slug": "Community/CODE_OF_CONDUCT",
+ "title": "CODE_OF_CONDUCT"
+ },
+ {
+ "body": {
+ "raw": "# Contributing to MarkFlowy\n\nWelcome, and thank you for your interest in contributing to MarkFlowy!\n\n## How to Contribute Code\n\n### Prerequisites\n\nIn order to download necessary tools, clone the repository, and install dependencies via yarn, you need network access.\n\nYou'll need the following tools:\n\n- [Git](https://git-scm.com/)\n- [Node.JS](https://nodejs.org/en) >= 20.x\n- [yarn](https://yarnpkg.com/) 4.0.0\n- [rust](https://www.rust-lang.org/) >= 1.79.0\n\n### Table of Contents\n\n- [Contributing to MarkFlowy](#contributing-to-markflowy)\n - [How to Contribute Code](#how-to-contribute-code)\n - [Prerequisites](#prerequisites)\n - [Table of Contents](#table-of-contents)\n - [Contribute multilingual translations steps](#contribute-multilingual-translations-steps)\n - [Fork](#fork)\n - [Translation file](#translation-file)\n - [Development work steps](#development-work-steps)\n - [Fork](#fork-1)\n - [Dependency installation](#dependency-installation)\n - [Startup MarkFlowy](#startup-markflowy)\n- [Thank You!](#thank-you)\n\n### Contribute multilingual translations steps\n\nFor some users who don't want to go through the complicated project startup steps and just want to participate in the translation work, you can check the following steps.\n\n#### Fork\n\nFork [MarkFlowy](https://github.com/drl990114/MarkFlowy) and `git clone`\n\n#### Translation file\n\nIn order to facilitate everyone's participation, the translation file path is placed in locales in the project root directory. If you want to add a new language, you can directly refer to the en.json file for translation.\n\n### Development work steps\n\n#### Fork\n\nFork [MarkFlowy](https://github.com/drl990114/MarkFlowy) and `git clone`\n\n#### Dependency installation\n\nExecute the following command to install related dependencies.\n\n```bash\nyarn install\n```\n\nand\n\n```bash\ncargo install --locked --path apps/desktop/src-tauri\n```\n\n#### Startup MarkFlowy\n\nExecute the following command, you will start MarkFlowy.\n\n```bash\nyarn dev:desktop\n```\n\n# Thank You!\n\nYour contributions to open source, large or small, make the project better. Thank you for taking the time to contribute.\n",
+ "html": "Contributing to MarkFlowy
\nWelcome, and thank you for your interest in contributing to MarkFlowy!
\nHow to Contribute Code
\nPrerequisites
\nIn order to download necessary tools, clone the repository, and install dependencies via yarn, you need network access.
\nYou'll need the following tools:
\n\nTable of Contents
\n\nContribute multilingual translations steps
\nFor some users who don't want to go through the complicated project startup steps and just want to participate in the translation work, you can check the following steps.
\nFork
\nFork MarkFlowy and git clone
\nTranslation file
\nIn order to facilitate everyone's participation, the translation file path is placed in locales in the project root directory. If you want to add a new language, you can directly refer to the en.json file for translation.
\nDevelopment work steps
\nFork
\nFork MarkFlowy and git clone
\nDependency installation
\nExecute the following command to install related dependencies.
\nyarn install\n
\nand
\ncargo install --locked --path apps/desktop/src-tauri\n
\nStartup MarkFlowy
\nExecute the following command, you will start MarkFlowy.
\nyarn dev:desktop\n
\nThank You!
\nYour contributions to open source, large or small, make the project better. Thank you for taking the time to contribute.
"
+ },
+ "_id": "Community/CONTRIBUTING.md",
+ "_raw": {
+ "sourceFilePath": "Community/CONTRIBUTING.md",
+ "sourceFileName": "CONTRIBUTING.md",
+ "sourceFileDir": "Community",
+ "contentType": "markdown",
+ "flattenedPath": "Community/CONTRIBUTING"
+ },
+ "type": "Markdown",
+ "slug": "Community/CONTRIBUTING",
+ "title": "CONTRIBUTING"
+ },
+ {
+ "body": {
+ "raw": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Remote Network Interaction; Use with the GNU General Public License.\n\n Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n.\n",
+ "html": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n
\nCopyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/\nEveryone is permitted to copy and distribute verbatim copies\nof this license document, but changing it is not allowed.
\n Preamble\n
\nThe GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.
\nThe licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.
\nWhen we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.
\nDevelopers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.
\nA secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.
\nThe GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.
\nAn older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.
\nThe precise terms and conditions for copying, distribution and\nmodification follow.
\n TERMS AND CONDITIONS\n
\n0. Definitions.
\n\"This License\" refers to version 3 of the GNU Affero General Public License.
\n\"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.
\n\"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.
\nTo \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.
\nA \"covered work\" means either the unmodified Program or a work based\non the Program.
\nTo \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.
\nTo \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.
\nAn interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.
\n\n- Source Code.
\n
\nThe \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.
\nA \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.
\nThe \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.
\nThe \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.
\nThe Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.
\nThe Corresponding Source for a work in source code form is that\nsame work.
\n\n- Basic Permissions.
\n
\nAll rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.
\nYou may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.
\nConveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.
\n\n- Protecting Users' Legal Rights From Anti-Circumvention Law.
\n
\nNo covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.
\nWhen you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.
\n\n- Conveying Verbatim Copies.
\n
\nYou may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.
\nYou may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.
\n\n- Conveying Modified Source Versions.
\n
\nYou may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:
\na) The work must carry prominent notices stating that you modified\nit, and giving a relevant date.\n\nb) The work must carry prominent notices stating that it is\nreleased under this License and any conditions added under section\n7. This requirement modifies the requirement in section 4 to\n\"keep intact all notices\".\n\nc) You must license the entire work, as a whole, under this\nLicense to anyone who comes into possession of a copy. This\nLicense will therefore apply, along with any applicable section 7\nadditional terms, to the whole of the work, and all its parts,\nregardless of how they are packaged. This License gives no\npermission to license the work in any other way, but it does not\ninvalidate such permission if you have separately received it.\n\nd) If the work has interactive user interfaces, each must display\nAppropriate Legal Notices; however, if the Program has interactive\ninterfaces that do not display Appropriate Legal Notices, your\nwork need not make them do so.\n
\nA compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.
\n\n- Conveying Non-Source Forms.
\n
\nYou may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:
\na) Convey the object code in, or embodied in, a physical product\n(including a physical distribution medium), accompanied by the\nCorresponding Source fixed on a durable physical medium\ncustomarily used for software interchange.\n\nb) Convey the object code in, or embodied in, a physical product\n(including a physical distribution medium), accompanied by a\nwritten offer, valid for at least three years and valid for as\nlong as you offer spare parts or customer support for that product\nmodel, to give anyone who possesses the object code either (1) a\ncopy of the Corresponding Source for all the software in the\nproduct that is covered by this License, on a durable physical\nmedium customarily used for software interchange, for a price no\nmore than your reasonable cost of physically performing this\nconveying of source, or (2) access to copy the\nCorresponding Source from a network server at no charge.\n\nc) Convey individual copies of the object code with a copy of the\nwritten offer to provide the Corresponding Source. This\nalternative is allowed only occasionally and noncommercially, and\nonly if you received the object code with such an offer, in accord\nwith subsection 6b.\n\nd) Convey the object code by offering access from a designated\nplace (gratis or for a charge), and offer equivalent access to the\nCorresponding Source in the same way through the same place at no\nfurther charge. You need not require recipients to copy the\nCorresponding Source along with the object code. If the place to\ncopy the object code is a network server, the Corresponding Source\nmay be on a different server (operated by you or a third party)\nthat supports equivalent copying facilities, provided you maintain\nclear directions next to the object code saying where to find the\nCorresponding Source. Regardless of what server hosts the\nCorresponding Source, you remain obligated to ensure that it is\navailable for as long as needed to satisfy these requirements.\n\ne) Convey the object code using peer-to-peer transmission, provided\nyou inform other peers where the object code and Corresponding\nSource of the work are being offered to the general public at no\ncharge under subsection 6d.\n
\nA separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.
\nA \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.
\n\"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.
\nIf you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).
\nThe requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.
\nCorresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.
\n\n- Additional Terms.
\n
\n\"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.
\nWhen you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.
\nNotwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:
\na) Disclaiming warranty or limiting liability differently from the\nterms of sections 15 and 16 of this License; or\n\nb) Requiring preservation of specified reasonable legal notices or\nauthor attributions in that material or in the Appropriate Legal\nNotices displayed by works containing it; or\n\nc) Prohibiting misrepresentation of the origin of that material, or\nrequiring that modified versions of such material be marked in\nreasonable ways as different from the original version; or\n\nd) Limiting the use for publicity purposes of names of licensors or\nauthors of the material; or\n\ne) Declining to grant rights under trademark law for use of some\ntrade names, trademarks, or service marks; or\n\nf) Requiring indemnification of licensors and authors of that\nmaterial by anyone who conveys the material (or modified versions of\nit) with contractual assumptions of liability to the recipient, for\nany liability that these contractual assumptions directly impose on\nthose licensors and authors.\n
\nAll other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.
\nIf you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.
\nAdditional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.
\n\n- Termination.
\n
\nYou may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).
\nHowever, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.
\nMoreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.
\nTermination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.
\n\n- Acceptance Not Required for Having Copies.
\n
\nYou are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.
\n\n- Automatic Licensing of Downstream Recipients.
\n
\nEach time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.
\nAn \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.
\nYou may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.
\n\n- Patents.
\n
\nA \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".
\nA contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.
\nEach contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.
\nIn the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.
\nIf you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.
\nIf, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.
\nA patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.
\nNothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.
\n\n- No Surrender of Others' Freedom.
\n
\nIf conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.
\n\n- Remote Network Interaction; Use with the GNU General Public License.
\n
\nNotwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.
\nNotwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.
\n\n- Revised Versions of this License.
\n
\nThe Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.
\nEach version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.
\nIf the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.
\nLater license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.
\n\n- Disclaimer of Warranty.
\n
\nTHERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.
\n\n- Limitation of Liability.
\n
\nIN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.
\n\n- Interpretation of Sections 15 and 16.
\n
\nIf the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.
\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n
\nIf you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.
\nTo do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.
\n<one line to give the program's name and a brief idea of what it does.>\nCopyright (C) <year> <name of author>\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n
\nAlso add information on how to contact you by electronic and paper mail.
\nIf your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.
\nYou should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\nhttps://www.gnu.org/licenses/.
"
+ },
+ "_id": "Community/License.md",
+ "_raw": {
+ "sourceFilePath": "Community/License.md",
+ "sourceFileName": "License.md",
+ "sourceFileDir": "Community",
+ "contentType": "markdown",
+ "flattenedPath": "Community/License"
+ },
+ "type": "Markdown",
+ "slug": "Community/License",
+ "title": "License"
+ },
+ {
+ "body": {
+ "raw": "# Custom Theme\n\nMarkFlowy supports custom themes, and you can also share your themes with others.\n\n## Develop Environment\n\n- MarkFlowy > 0.7.0\n- nodejs >= 18.x\n- pnpm >= 7.x\n\n## How to make a theme\n\n### 1. Create theme files\n\nYou can fork [MarkFlowy-Theme-Template](https://github.com/MarkFlowy/custom-theme-template) to create your theme.\n\n```bash\npnpm install\n\npnpm run dev\n```\n\n### 2. Edit theme files\n\nOpen MarkFlowy, click `Settings`, you can see `path`, Open this path folder, create `themes` folder in `.markflowy` folder, and then create your theme folder in `themes` folder, e.g. `markflowy-theme-template`.\n\nYou can edit `rollup.config.js` to change the theme build files output.\n\n\n```js\noutput: {\n // change this output file to development\n // e.g. file: '/Users/xxx/.markflowy/themes/markflowy-theme-template/index.js',\n file: pkg.browser,\n format: 'es',\n sourcemap: true,\n entryFileNames: '[name].js',\n},\n```\n\nchange your theme, reload MarkFlowy to see the effect.\n\n\n\n\n",
+ "html": "Custom Theme
\nMarkFlowy supports custom themes, and you can also share your themes with others.
\nDevelop Environment
\n\n- MarkFlowy > 0.7.0
\n- nodejs >= 18.x
\n- pnpm >= 7.x
\n
\nHow to make a theme
\n1. Create theme files
\nYou can fork MarkFlowy-Theme-Template to create your theme.
\npnpm install\n\npnpm run dev\n
\n2. Edit theme files
\nOpen MarkFlowy, click Settings, you can see path, Open this path folder, create themes folder in .markflowy folder, and then create your theme folder in themes folder, e.g. markflowy-theme-template.
\nYou can edit rollup.config.js to change the theme build files output.
\noutput: {\n // change this output file to development\n // e.g. file: '/Users/xxx/.markflowy/themes/markflowy-theme-template/index.js',\n file: pkg.browser,\n format: 'es',\n sourcemap: true,\n entryFileNames: '[name].js',\n},\n
\nchange your theme, reload MarkFlowy to see the effect.
"
+ },
+ "_id": "Extension/CustomTheme.md",
+ "_raw": {
+ "sourceFilePath": "Extension/CustomTheme.md",
+ "sourceFileName": "CustomTheme.md",
+ "sourceFileDir": "Extension",
+ "contentType": "markdown",
+ "flattenedPath": "Extension/CustomTheme"
+ },
+ "type": "Markdown",
+ "slug": "Extension/CustomTheme",
+ "title": "CustomTheme"
+ }
+]
\ No newline at end of file
diff --git a/apps/web/.contentlayer/generated/Markdown/_index.mjs b/apps/web/.contentlayer/generated/Markdown/_index.mjs
new file mode 100644
index 000000000..55fde3571
--- /dev/null
+++ b/apps/web/.contentlayer/generated/Markdown/_index.mjs
@@ -0,0 +1,9 @@
+// NOTE This file is auto-generated by Contentlayer
+
+import introMd from './intro.md.json' with { type: 'json' }
+import community__code_of_conductMd from './Community__CODE_OF_CONDUCT.md.json' with { type: 'json' }
+import community__contributingMd from './Community__CONTRIBUTING.md.json' with { type: 'json' }
+import community__licenseMd from './Community__License.md.json' with { type: 'json' }
+import extension__customThemeMd from './Extension__CustomTheme.md.json' with { type: 'json' }
+
+export const allMarkdowns = [introMd, community__code_of_conductMd, community__contributingMd, community__licenseMd, extension__customThemeMd]
diff --git a/apps/web/.contentlayer/generated/Markdown/intro.md.json b/apps/web/.contentlayer/generated/Markdown/intro.md.json
new file mode 100644
index 000000000..ad3b2fdaa
--- /dev/null
+++ b/apps/web/.contentlayer/generated/Markdown/intro.md.json
@@ -0,0 +1,17 @@
+{
+ "body": {
+ "raw": "# MarkFlowy\n\n## MarkFlowy is in Alpha\n\nCurrently, MarkFlowy is still in the alpha phase,This means there may be incompatible version updates, and it is recommended to use it when there is data backup available. \n\n## Feature\n\n- **Built-in ChatGpt**. Currently supports one-click export of conversations, making chatgpt your smart assistant.\n- **Super lightweight**. The MarkFlowy is based on tauri and has a volume of less than 10MB and better performance.\n- **High availability**. MarkFlowy uses the remirror editor, which not only provides high scalability, but also has a great editing experience. And, MarkFlowy supports multiple editing modes, such as `source code`, `wysiyg`.\n\n## Download\n\nAvailable for Linux, macOS and Windows.\n\nPlease look [releases page](https://github.com/drl990114/MarkFlowy/releases)\n\n## Why\nAt present, I have used many Markdown applications, but I have not encountered one that is very suitable for me. I have always hoped to have a Markdown editor that is efficient, beautiful, lightweight, data-safe, and can be easily combined with various workflows. This It is also the original intention of doing MarkFlowy.\n\n## Contribute\n\nThe current MarkFlowy is still in its infancy, and there may be some bad experiences or bugs, for which I am sorry. All partners who are interested or encounter usage problems are welcome to submit [issues](https://github.com/drl990114/MarkFlowy/issues/new) or [PR](https://github.com/drl990114/MarkFlowy/compare) to participate in this project.\n\n### How to Contribute\n\nYou can read [CONTRIBUTING](./Community/CONTRIBUTING.md) to know how to start the project and modify the code, Welcome to participate in code contribution.\n\n## Support\n\nMarkFlowy is completely and permanently open source, if you want to support MarkFlowy, you can `star` this project. This will give me great support and help, love you.\n\n## Thanks\n\n- Tauri - A framework for building cross-platform applications that provides MarkFlowy with a solid foundation.\n- React - Web user interface framework.\n- Remirror - The ProseMirror toolkit for React, on which the MarkFlowy editor is based.\n- Rino - Some initialization codes of package/editor come from here.\n- Vite - front-end build tool.\n- Xplorer - Home page theme from xplorer.\n\nAnd, thanks to all the open source projects that MarkFlowy depends on.\n\n",
+ "html": "MarkFlowy
\nMarkFlowy is in Alpha
\nCurrently, MarkFlowy is still in the alpha phase,This means there may be incompatible version updates, and it is recommended to use it when there is data backup available.
\nFeature
\n\n- Built-in ChatGpt. Currently supports one-click export of conversations, making chatgpt your smart assistant.
\n- Super lightweight. The MarkFlowy is based on tauri and has a volume of less than 10MB and better performance.
\n- High availability. MarkFlowy uses the remirror editor, which not only provides high scalability, but also has a great editing experience. And, MarkFlowy supports multiple editing modes, such as
source code, wysiyg. \n
\nDownload
\nAvailable for Linux, macOS and Windows.
\nPlease look releases page
\nWhy
\nAt present, I have used many Markdown applications, but I have not encountered one that is very suitable for me. I have always hoped to have a Markdown editor that is efficient, beautiful, lightweight, data-safe, and can be easily combined with various workflows. This It is also the original intention of doing MarkFlowy.
\nContribute
\nThe current MarkFlowy is still in its infancy, and there may be some bad experiences or bugs, for which I am sorry. All partners who are interested or encounter usage problems are welcome to submit issues or PR to participate in this project.
\nHow to Contribute
\nYou can read CONTRIBUTING to know how to start the project and modify the code, Welcome to participate in code contribution.
\nSupport
\nMarkFlowy is completely and permanently open source, if you want to support MarkFlowy, you can star this project. This will give me great support and help, love you.
\nThanks
\n\n- Tauri - A framework for building cross-platform applications that provides MarkFlowy with a solid foundation.
\n- React - Web user interface framework.
\n- Remirror - The ProseMirror toolkit for React, on which the MarkFlowy editor is based.
\n- Rino - Some initialization codes of package/editor come from here.
\n- Vite - front-end build tool.
\n- Xplorer - Home page theme from xplorer.
\n
\nAnd, thanks to all the open source projects that MarkFlowy depends on.
"
+ },
+ "_id": "intro.md",
+ "_raw": {
+ "sourceFilePath": "intro.md",
+ "sourceFileName": "intro.md",
+ "sourceFileDir": ".",
+ "contentType": "markdown",
+ "flattenedPath": "intro"
+ },
+ "type": "Markdown",
+ "slug": "intro",
+ "title": "intro"
+}
\ No newline at end of file
diff --git a/apps/web/.contentlayer/generated/Post/_index.json b/apps/web/.contentlayer/generated/Post/_index.json
new file mode 100644
index 000000000..0637a088a
--- /dev/null
+++ b/apps/web/.contentlayer/generated/Post/_index.json
@@ -0,0 +1 @@
+[]
\ No newline at end of file
diff --git a/apps/web/.contentlayer/generated/Post/_index.mjs b/apps/web/.contentlayer/generated/Post/_index.mjs
new file mode 100644
index 000000000..6f01425eb
--- /dev/null
+++ b/apps/web/.contentlayer/generated/Post/_index.mjs
@@ -0,0 +1,5 @@
+// NOTE This file is auto-generated by Contentlayer
+
+
+
+export const allPosts = []
diff --git a/apps/web/.contentlayer/generated/index.d.ts b/apps/web/.contentlayer/generated/index.d.ts
new file mode 100644
index 000000000..e0f385269
--- /dev/null
+++ b/apps/web/.contentlayer/generated/index.d.ts
@@ -0,0 +1,13 @@
+// NOTE This file is auto-generated by Contentlayer
+
+import { Post, Markdown, DocumentTypes, DataExports } from './types'
+import { SourceProvideSchemaErrorJSON, SourceFetchDataErrorJSON } from 'contentlayer2/core'
+
+export * from './types'
+
+export declare const allPosts: Post[]
+export declare const allMarkdowns: Markdown[]
+
+export declare const allDocuments: DocumentTypes[]
+
+
diff --git a/apps/web/.contentlayer/generated/index.mjs b/apps/web/.contentlayer/generated/index.mjs
new file mode 100644
index 000000000..1ac99b28a
--- /dev/null
+++ b/apps/web/.contentlayer/generated/index.mjs
@@ -0,0 +1,14 @@
+// NOTE This file is auto-generated by Contentlayer
+
+export { isType } from 'contentlayer2/client'
+
+// NOTE During development Contentlayer imports from `.mjs` files to improve HMR speeds.
+// During (production) builds Contentlayer it imports from `.json` files to improve build performance.
+import allPosts from './Post/_index.json' with { type: 'json' }
+import allMarkdowns from './Markdown/_index.json' with { type: 'json' }
+
+export { allPosts, allMarkdowns }
+
+export const allDocuments = [...allPosts, ...allMarkdowns]
+
+
diff --git a/apps/web/.contentlayer/generated/types.d.ts b/apps/web/.contentlayer/generated/types.d.ts
new file mode 100644
index 000000000..9b53798c4
--- /dev/null
+++ b/apps/web/.contentlayer/generated/types.d.ts
@@ -0,0 +1,77 @@
+// NOTE This file is auto-generated by Contentlayer
+
+import type { Markdown, MDX, ImageFieldData, IsoDateTimeString } from 'contentlayer2/core'
+import * as Local from 'contentlayer2/source-files'
+
+export { isType } from 'contentlayer2/client'
+
+export type { Markdown, MDX, ImageFieldData, IsoDateTimeString }
+
+/** Document types */
+export type Markdown = {
+ /** File path relative to `contentDirPath` */
+ _id: string
+ _raw: Local.RawDocumentData
+ type: 'Markdown'
+ /** Markdown file body */
+ body: Markdown
+ slug: string
+ title: string
+}
+
+export type Post = {
+ /** File path relative to `contentDirPath` */
+ _id: string
+ _raw: Local.RawDocumentData
+ type: 'Post'
+ /** MDX file body */
+ body: MDX
+ slug: string
+}
+
+/** Nested types */
+
+
+/** Helper types */
+
+export type AllTypes = DocumentTypes | NestedTypes
+export type AllTypeNames = DocumentTypeNames | NestedTypeNames
+
+export type DocumentTypes = Markdown | Post
+export type DocumentTypeNames = 'Markdown' | 'Post'
+
+export type NestedTypes = never
+export type NestedTypeNames = never
+
+export type DataExports = {
+ allDocuments: DocumentTypes[]
+ allPosts: Post[]
+ allMarkdowns: Markdown[]
+}
+
+
+export interface ContentlayerGenTypes {
+ documentTypes: DocumentTypes
+ documentTypeMap: DocumentTypeMap
+ documentTypeNames: DocumentTypeNames
+ nestedTypes: NestedTypes
+ nestedTypeMap: NestedTypeMap
+ nestedTypeNames: NestedTypeNames
+ allTypeNames: AllTypeNames
+ dataExports: DataExports
+}
+
+declare global {
+ interface ContentlayerGen extends ContentlayerGenTypes {}
+}
+
+export type DocumentTypeMap = {
+ Markdown: Markdown
+ Post: Post
+}
+
+export type NestedTypeMap = {
+
+}
+
+
\ No newline at end of file
diff --git a/apps/web/.contentlayer/package.json b/apps/web/.contentlayer/package.json
new file mode 100644
index 000000000..0839547aa
--- /dev/null
+++ b/apps/web/.contentlayer/package.json
@@ -0,0 +1,17 @@
+{
+ "name": "dot-contentlayer",
+ "description": "This package is auto-generated by Contentlayer",
+ "version": "0.0.0-PTYAUPAV",
+ "exports": {
+ "./generated": {
+ "import": "./generated/index.mjs"
+ }
+ },
+ "typesVersions": {
+ "*": {
+ "generated": [
+ "./generated"
+ ]
+ }
+ }
+}
\ No newline at end of file
diff --git a/apps/web/.gitignore b/apps/web/.gitignore
new file mode 100644
index 000000000..6e00c67b3
--- /dev/null
+++ b/apps/web/.gitignore
@@ -0,0 +1,26 @@
+# Node
+node_modules
+*.log
+.env
+lib/
+es/
+dist/
+npm-debug.log
+_book/
+package-lock.json
+__diff_output__
+
+# Mac
+.DS_Store
+
+# build
+.next
+
+# Yarn 3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
diff --git a/apps/web/.nvmrc b/apps/web/.nvmrc
new file mode 100644
index 000000000..209e3ef4b
--- /dev/null
+++ b/apps/web/.nvmrc
@@ -0,0 +1 @@
+20
diff --git a/apps/web/LICENSE b/apps/web/LICENSE
new file mode 100644
index 000000000..624247814
--- /dev/null
+++ b/apps/web/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 - present Glen Maddern and Maximilian Stoiber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.
diff --git a/apps/web/README.md b/apps/web/README.md
new file mode 100644
index 000000000..37c08a981
--- /dev/null
+++ b/apps/web/README.md
@@ -0,0 +1 @@
+# web site
diff --git a/apps/web/components/Anchor.tsx b/apps/web/components/Anchor.tsx
new file mode 100644
index 000000000..2318e70cd
--- /dev/null
+++ b/apps/web/components/Anchor.tsx
@@ -0,0 +1,89 @@
+import { Link as LinkIcon } from '@styled-icons/material/Link/Link'
+import styled, { css } from 'styled-components'
+import { mobile } from '../utils/media'
+import rem from '../utils/rem'
+import { Header, SubHeader, TertiaryHeader } from './Layout'
+
+export interface AnchorProps {
+ id?: string
+ level?: number
+}
+
+export default function Anchor({
+ children,
+ level,
+ id,
+ ...props
+}: React.PropsWithChildren) {
+ let override = undefined
+
+ switch (level) {
+ case 3:
+ override = SubHeader
+ break
+ case 4:
+ override = TertiaryHeader
+ break
+ default:
+ override = Header
+ break
+ }
+
+ return (
+
+
+
+ {children}
+
+
+
+
+
+ )
+}
+
+const InvisibleAnchor = styled.div.attrs((/* props */) => ({
+ 'aria-hidden': true,
+}))`
+ position: relative;
+ display: block;
+ visibility: hidden;
+ height: 0;
+
+ top: ${rem(-70)};
+
+ ${mobile(css`
+ top: ${rem(-90)};
+ `)};
+`
+
+const AnchorPrimitive = styled.a`
+ display: none;
+ color: inherit;
+ margin-left: ${rem(10)};
+`
+
+const AnchorIcon = styled(LinkIcon)`
+ width: ${rem(20)};
+ opacity: 0.7;
+ margin-top: ${rem(-5)};
+
+ &:hover {
+ opacity: 0.9;
+ }
+`
+
+const AnchorHeader = styled.div`
+ position: relative;
+
+ ${mobile(css`
+ /* stylelint-disable-next-line */
+ ${AnchorPrimitive} {
+ display: inline-block;
+ }
+ `)}
+
+ &:hover ${AnchorPrimitive} {
+ display: inline-block;
+ }
+`
diff --git a/apps/web/components/CaptureScroll.tsx b/apps/web/components/CaptureScroll.tsx
new file mode 100644
index 000000000..24f00b6bd
--- /dev/null
+++ b/apps/web/components/CaptureScroll.tsx
@@ -0,0 +1,87 @@
+import React from 'react'; // eslint-disable-line
+
+let isMobile: boolean;
+let lastWheelTimestamp: number;
+
+if (typeof window !== 'undefined' && window.matchMedia) {
+ isMobile = window.matchMedia(`(max-width: ${1000 / 16}em)`).matches;
+
+ if (!isMobile) {
+ window.addEventListener('wheel', ({ timeStamp }) => {
+ lastWheelTimestamp = timeStamp;
+ });
+ }
+}
+
+export default function captureScroll(Component: T) {
+ if (isMobile) {
+ return Component;
+ }
+
+ return function CaptureScroll(props: React.ComponentProps) {
+ const ref = React.useRef(null);
+
+ const handleScroll = React.useCallback((evt: Event & { deltaY: number }) => {
+ if (!ref.current) return;
+
+ // Don't access window wheel listener
+ evt.stopImmediatePropagation();
+
+ const { timeStamp, deltaY } = evt;
+ const { offsetHeight, scrollHeight, scrollTop } = ref.current;
+
+ // If the window is being scrolled, don't scroll the captured scroll area
+ if (timeStamp - lastWheelTimestamp <= 400) {
+ lastWheelTimestamp = timeStamp;
+
+ evt.preventDefault();
+ window.scrollBy(0, deltaY);
+ return;
+ }
+
+ const maxScrollTop = scrollHeight - offsetHeight;
+
+ // Has the scroll area reached it's beginning/end
+ const hasReachedTop = deltaY < 0 && scrollTop === 0;
+ const hasReachedBottom = deltaY > 0 && scrollTop >= maxScrollTop;
+
+ // Is the trajectory overshooting the scroll area
+ const isReachingTop = scrollTop + deltaY <= 0;
+ const isReachingBottom = scrollTop + deltaY >= maxScrollTop;
+
+ if (hasReachedTop || hasReachedBottom || isReachingTop || isReachingBottom) {
+ evt.preventDefault();
+ }
+
+ // If we're overshooting, we need to set the maximum available position
+ if (isReachingTop || isReachingBottom) {
+ ref.current!.scrollTop = isReachingTop ? 0 : maxScrollTop;
+ }
+ }, []);
+
+ const handleResize = React.useCallback(() => {
+ isMobile = window.matchMedia(`(max-width: ${1000 / 16}em)`).matches;
+
+ if (isMobile) {
+ ref.current?.removeEventListener('wheel', handleScroll);
+ } else {
+ ref.current?.addEventListener('wheel', handleScroll);
+ }
+
+ return () => ref.current?.removeEventListener('wheel', handleScroll);
+ }, []);
+
+ React.useEffect(() => {
+ ref.current?.addEventListener('wheel', handleScroll);
+ window.addEventListener('resize', handleResize);
+
+ return () => {
+ ref.current?.removeEventListener('wheel', handleScroll);
+ window.removeEventListener('resize', handleResize);
+ };
+ }, []);
+
+ // @ts-expect-error don't think there's a way to infer the proper ref type ahead of time
+ return ;
+ };
+}
diff --git a/apps/web/components/DocsLayout.tsx b/apps/web/components/DocsLayout.tsx
new file mode 100644
index 000000000..8ab4a41ae
--- /dev/null
+++ b/apps/web/components/DocsLayout.tsx
@@ -0,0 +1,62 @@
+import React from 'react';
+import { Container, Content, Title } from './Layout';
+import Nav, { NavProps } from './Nav';
+import Head from './SeoHead';
+import { useRouter } from 'next/router';
+
+export interface DocsLayoutProps {
+ description?: string;
+ pages?: NavProps['pages'];
+ title?: string;
+ useDocsSidebarMenu?: boolean;
+}
+
+export default function DocsLayout({
+ children,
+ title = '',
+ description = '',
+ useDocsSidebarMenu = true,
+ pages,
+}: React.PropsWithChildren) {
+ const router = useRouter();
+ const [isSideFolded, setIsSideFolded] = React.useState(true);
+ const [isMobileNavFolded, setIsMobileNavFolded] = React.useState(true);
+
+ const onSideToggle = React.useCallback(() => {
+ setIsMobileNavFolded(true);
+ setIsSideFolded(x => !x);
+ }, []);
+
+ const onMobileNavToggle = React.useCallback(() => {
+ setIsMobileNavFolded(x => !x);
+ setIsSideFolded(true);
+ }, []);
+
+ React.useEffect(() => {
+ setIsMobileNavFolded(true);
+ setIsSideFolded(true);
+ }, [router.asPath]);
+
+ return (
+
+
+
+
+
+
+
+
+ {title}
+
+ {children}
+
+
+ );
+}
diff --git a/apps/web/components/Feature.tsx b/apps/web/components/Feature.tsx
new file mode 100644
index 000000000..2e9da646e
--- /dev/null
+++ b/apps/web/components/Feature.tsx
@@ -0,0 +1,67 @@
+import FeatureCard from './FeatureCard'
+import styled, { css } from 'styled-components'
+import rem from 'utils/rem'
+import { mobile } from 'utils/media'
+
+const Container = styled.section`
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ margin: 20px 0;
+ width: 100%;
+
+ .feature-cards {
+ display: flex;
+ flex-direction: column;
+ width: 100%;
+ padding: 0 ${rem(60)};
+ gap: ${rem(60)};
+ box-sizing: border-box;
+
+ ${() =>
+ mobile(css`
+ padding: 0 ${rem(30)};
+ `)};
+ }
+`
+
+export type Feature = {
+ title: string
+ descs: string[]
+ img: string
+}
+
+export default function Feature() {
+ const features = [
+ {
+ title: 'High availability',
+ descs: [
+ `MarkFlowy uses the remirror editor, which not only provides high scalability, but also has a great editing experience. And, MarkFlowy supports multiple editing modes, such as 'source code', 'wysiwyg'.`,
+ ],
+ img: '/screenshots/sourcecode.png',
+ },
+ {
+ title: 'Custom Theme',
+ descs: [
+ `MarkFlowy comes with a dark theme and supports custom themes. You can also share themes with others.`,
+ ],
+ img: '/screenshots/darkmode.png',
+ },
+ {
+ title: 'Built-in ChatGPT',
+ descs: [
+ `Currently supports one-click export of conversations、translate markdown articles and et article abstract, making chatgpt your smart assistant.`,
+ ],
+ img: '/screenshots/chatgpt.png',
+ },
+ ]
+ return (
+
+
+ {features.map((feature) => {
+ return
+ })}
+
+
+ )
+}
diff --git a/apps/web/components/FeatureCard.tsx b/apps/web/components/FeatureCard.tsx
new file mode 100644
index 000000000..ac470f899
--- /dev/null
+++ b/apps/web/components/FeatureCard.tsx
@@ -0,0 +1,83 @@
+'use client'
+import styled, { css } from 'styled-components'
+import Image from 'next/image'
+import { Feature } from './Feature'
+import { mobile } from 'utils/media'
+import rem from 'utils/rem'
+
+type FeatureCardProps = {
+ feature: Feature
+}
+const FeatureCard = (props: FeatureCardProps) => {
+ const { feature } = props
+
+ return (
+
+
+
{feature.title}
+ {feature.descs.map((desc) => {
+ return
{desc}
+ })}
+
+
+
+
+ )
+}
+
+const Container = styled.div`
+ display: flex;
+ justify-content: space-around;
+ align-items: flex-start;
+ width: 100%;
+ column-gap: 3rem;
+
+ .feature-card {
+ &__left {
+ flex: 1;
+ text-align: left;
+
+ @media screen and (max-width: 1280px) {
+ width: 100%;
+ height: auto;
+ }
+ }
+
+ &__right {
+ width: 720px;
+ height: 480px;
+
+ img {
+ width: 100%;
+ height: 100%;
+ }
+
+ @media screen and (max-width: 1280px) {
+ width: 100%;
+ height: auto;
+ display: flex;
+ justify-content: flex-start;
+
+ img {
+ max-width: 720px;
+ height: auto;
+ }
+ }
+ }
+ }
+
+ @media screen and (max-width: 1280px) {
+ width: 100%;
+ flex-direction: column;
+ align-items: center;
+ }
+`
+
+export default FeatureCard
diff --git a/apps/web/components/Footer/index.tsx b/apps/web/components/Footer/index.tsx
new file mode 100644
index 000000000..ee5e651db
--- /dev/null
+++ b/apps/web/components/Footer/index.tsx
@@ -0,0 +1,63 @@
+import { Favorite } from '@styled-icons/material/Favorite/Favorite'
+import styled, { css } from 'styled-components'
+import { grey, paleGrey, red } from '../../utils/colors'
+import { mobile } from '../../utils/media'
+import rem from '../../utils/rem'
+import { Content } from '../Layout'
+import Link from '../Link'
+
+export default function Footer() {
+ return (
+
+
+ {'Hosted on '}
+
+ ▲ Vercel
+
+
+ {'Made with '}
+
+ {' by '}
+
+ @drl990114
+
+ {' and '}
+
+ contributors
+
+ {'.'}
+
+
+ )
+}
+
+const Wrapper = styled.footer`
+ display: flex;
+ flex-direction: column;
+ justify-content: center;
+ align-items: center;
+ text-align: center;
+ color: ${(props) => props.theme.primaryFontColor};
+ background: ${(props) => props.theme.footerBgColor};
+ font-size: 16px;
+ box-sizing: border-box;
+`
+
+const Heart = styled(Favorite)`
+ display: inline-block;
+ width: ${rem(17)};
+ color: ${red};
+ transform: translateY(-10%);
+`
+
+const FooterLink = styled(Link)`
+ color: ${(props) => props.theme.primaryFontColor};
+`
+
+const FooterContent = styled(Content)`
+ padding: ${rem(30)} ${rem(40)} ${rem(30)} ${rem(40)};
+
+ ${mobile(css`
+ padding: ${rem(30)} ${rem(20)} ${rem(30)} ${rem(20)};
+ `)};
+`
diff --git a/apps/web/components/Image.tsx b/apps/web/components/Image.tsx
new file mode 100644
index 000000000..0e18a716d
--- /dev/null
+++ b/apps/web/components/Image.tsx
@@ -0,0 +1,100 @@
+import * as CSS from 'csstype';
+import styled from 'styled-components';
+
+export interface ImageProps {
+ caption?: string;
+ captionSpacing?: number;
+ height: number;
+ margin?: number;
+ renderImage: (props: Pick) => React.ReactNode;
+ src: string;
+ video?: boolean;
+ width: number;
+}
+
+export default function Image({
+ caption,
+ captionSpacing,
+ height,
+ margin = 40,
+ renderImage,
+ width,
+ ...rest
+}: ImageProps) {
+ const aspectRatio = String((height / width) * 100) + '%';
+
+ return (
+
+
+ {renderImage && renderImage(rest)}
+
+ {caption && {caption}}
+
+
+ );
+}
+
+export interface VideoProps extends ImageProps {}
+
+export const Video = (props: VideoProps) => ;
+
+// This component might look a little complex
+// because one could argue that keeping the aspect ratio
+// of an image can be solved with `height: auto`,
+// but it's actually not that easy if you want to prevent
+// element flickering
+
+// Because if you want to do that, you need to set the aspect
+// ratio of the image's container BEFORE the image loads
+
+const Figure = styled.figure<{ $margin: number }>`
+ display: block;
+ text-align: center;
+ margin: ${props => props.$margin}px 0;
+ max-width: 100%;
+
+ & img {
+ height: 100%;
+ left: 0;
+ position: absolute;
+ top: 0;
+ width: 100%;
+ }
+
+ & .fade-enter {
+ opacity: 0.01;
+ }
+
+ & .fade-enter.fade-enter-active {
+ opacity: 1;
+ transition: opacity 500ms ease-in;
+ }
+
+ & .fade-exit {
+ opacity: 1;
+ }
+
+ & .fade-exit.fade-exit-active {
+ opacity: 0.01;
+ transition: opacity 300ms ease-in;
+ }
+`;
+
+const Main = styled.div<{ $width: number }>`
+ margin: 0 auto;
+ max-width: 100%;
+ width: ${props => props.$width}px;
+`;
+
+const Caption = styled.p<{ $captionSpacing?: number }>`
+ color: #999;
+ font-size: 12px;
+ margin: 0;
+ text-align: center;
+ ${props => (props.$captionSpacing ? `margin-top: ${props.$captionSpacing}px;` : '')};
+`;
+
+const ImageWrapper = styled.div<{ $aspectRatio: CSS.Properties['paddingBottom'] }>`
+ position: relative;
+ padding-bottom: ${props => props.$aspectRatio};
+`;
diff --git a/apps/web/components/Layout.tsx b/apps/web/components/Layout.tsx
new file mode 100644
index 000000000..86aeb0220
--- /dev/null
+++ b/apps/web/components/Layout.tsx
@@ -0,0 +1,82 @@
+import styled, { css } from 'styled-components'
+import { mobile } from '../utils/media'
+import rem from '../utils/rem'
+import { sidebarWidth } from '../utils/sizes'
+
+export const Container = styled.div`
+ padding-left: ${rem(sidebarWidth)};
+
+ ${mobile(css`
+ padding-left: 0;
+ `)};
+`
+
+export const Content = styled.div<{ $hero?: boolean; $moveRight?: boolean }>`
+ box-sizing: border-box;
+ font-family: ${(props) => props.theme.fontFamily};
+ margin: 0 auto;
+ max-width: ${(props) => (props.$hero ? '100ch' : '120ch')};
+ padding: ${rem(90)} ${rem(60)} 0 ${rem(60)};
+ transition: transform 150ms ease-out;
+
+ @layer base {
+ p,
+ li {
+ max-width: 100ch;
+ }
+ }
+
+ ${(p) =>
+ mobile(css`
+ padding: ${rem(100)} ${rem(36)} ${rem(30)} ${rem(36)};
+ transform: translateX(${p.$moveRight ? rem(sidebarWidth) : 0});
+ `)};
+
+ ${(p) =>
+ p.$hero &&
+ css`
+ padding: ${rem(170)} ${rem(60)} 0 ${rem(60)};
+ `};
+`
+
+export const Title = styled.h1`
+ text-align: left;
+ width: 100%;
+ color: ${props => props.theme.primaryFontColor};
+ font-size: ${rem(42)};
+ font-weight: bold;
+ font-family: ${(props) => props.theme.fontFamily};
+
+ + h2 {
+ margin-top: -0.5em;
+ }
+`
+
+export const Header = styled.h2`
+ font-size: ${rem(32)};
+ font-weight: 600;
+ font-family: ${(props) => props.theme.fontFamily};
+ margin: 2em 0 1em;
+
+ + h3 {
+ margin-top: -0.5em;
+ }
+`
+
+export const SubHeader = styled.h3`
+ margin: 2em 0 1em;
+ font-size: ${rem(24)};
+ font-weight: 600;
+ font-family: ${(props) => props.theme.fontFamily};
+
+ + h4 {
+ margin-top: -0.5em;
+ }
+`
+
+export const TertiaryHeader = styled.h4`
+ margin: 2em 0 1em;
+ font-size: ${rem(18)};
+ font-weight: 600;
+ font-family: ${(props) => props.theme.fontFamily};
+`
diff --git a/apps/web/components/Link.tsx b/apps/web/components/Link.tsx
new file mode 100644
index 000000000..550b86239
--- /dev/null
+++ b/apps/web/components/Link.tsx
@@ -0,0 +1,81 @@
+import UnstyledLink, { LinkProps as UnstyledLinkProps } from 'next/link';
+import React from 'react';
+import styled from 'styled-components';
+import { blmGrey, lightGrey, red } from '../utils/colors';
+import rem from '../utils/rem';
+
+type AnchorProps = JSX.IntrinsicElements['a'];
+
+export interface LinkProps extends UnstyledLinkProps, Omit {
+ inline?: boolean;
+ ref?: React.Ref;
+ unstyled?: boolean;
+ white?: boolean;
+ target?: '_self' | '_blank' | '_parent' | '_top';
+}
+
+export default function Link({
+ ['aria-label']: ariaLabel,
+ children,
+ className,
+ inline,
+ title,
+ unstyled,
+ white,
+ target,
+ ...rest
+}: LinkProps) {
+ let Child: keyof JSX.IntrinsicElements | React.ComponentType = StyledLink;
+
+ if (inline) {
+ Child = InlineLink;
+ } else if (unstyled) {
+ Child = 'a';
+ }
+
+ let dataAttrs;
+ if (white) {
+ dataAttrs = { 'data-white': white };
+ }
+
+ return (
+
+
+ {children}
+
+
+ );
+}
+
+export const StyledLink = styled.a`
+ display: inline-block;
+ color: inherit;
+ cursor: pointer;
+ padding: ${rem(2)} ${rem(8)};
+ margin: ${rem(-2)} ${rem(-8)};
+
+ @media (min-width: ${1000 / 16}em) {
+ border-radius: ${rem(3)};
+
+ &:hover {
+ background: ${lightGrey};
+ }
+ }
+`;
+
+export const InlineLink = styled.a.attrs((/* props */) => ({
+ target: '_blank',
+ rel: 'noopener',
+}))`
+ color: ${blmGrey};
+ cursor: pointer;
+ text-decoration: underline;
+
+ &:hover {
+ color: ${red};
+ }
+
+ &[data-white] {
+ color: white !important;
+ }
+`;
diff --git a/apps/web/components/Loading.tsx b/apps/web/components/Loading.tsx
new file mode 100644
index 000000000..f176bf56b
--- /dev/null
+++ b/apps/web/components/Loading.tsx
@@ -0,0 +1,27 @@
+import React from 'react';
+import styled, { keyframes } from 'styled-components';
+
+const rotate360 = keyframes`
+ from {
+ transform: rotate(0deg);
+ }
+
+ to {
+ transform: rotate(360deg);
+ }
+`;
+
+const StyledLoading = styled.div`
+ display: inline-block;
+ animation: ${rotate360} 2s linear infinite;
+ padding: 2rem 1rem;
+ font-size: 1.2rem;
+ position: absolute;
+ top: 50%;
+ transform: translateY(-50%) translateX(-50%);
+ left: 50%;
+`;
+
+const Loading = () => < 💅🏾 >;
+
+export default Loading;
diff --git a/apps/web/components/MdHtmlWrapper.tsx b/apps/web/components/MdHtmlWrapper.tsx
new file mode 100644
index 000000000..67c6442c3
--- /dev/null
+++ b/apps/web/components/MdHtmlWrapper.tsx
@@ -0,0 +1,18 @@
+import { ThemeProvider as RmeThemeProvider, WysiwygThemeWrapper } from 'rme'
+import { ThemeProvider as ZensThemeProvider } from 'zens'
+import { darkTheme } from 'theme'
+
+const MdHtmlWrapper = ({ children, ...rest }: any) => (
+
+
+ {children}
+
+
+)
+
+export default MdHtmlWrapper
diff --git a/apps/web/components/Nav/MobileNavbar.tsx b/apps/web/components/Nav/MobileNavbar.tsx
new file mode 100644
index 000000000..f9a3deaaf
--- /dev/null
+++ b/apps/web/components/Nav/MobileNavbar.tsx
@@ -0,0 +1,110 @@
+import { KeyboardArrowDown } from '@styled-icons/material/KeyboardArrowDown/KeyboardArrowDown';
+import styled, { css } from 'styled-components';
+import { mobile } from '../../utils/media';
+import rem from '../../utils/rem';
+import { navbarHeight } from '../../utils/sizes';
+import NavButton from './NavButton';
+import { CloseIcon, FoldIcon } from './NavIcons';
+import NavLinks from './NavLinks';
+
+export interface MobileNavbarProps {
+ isMobileNavFolded?: boolean;
+ isSideFolded?: boolean;
+ onMobileNavToggle?: () => void;
+ onSideToggle?: () => void;
+ showSideNav?: boolean;
+}
+
+export default function MobileNavbar({
+ children,
+ isMobileNavFolded,
+ isSideFolded,
+ onMobileNavToggle,
+ onSideToggle,
+ showSideNav,
+}: React.PropsWithChildren) {
+ return (
+
+ {showSideNav !== false && (
+ {isSideFolded ? : }
+ )}
+
+ MarkFlowy
+ {children}
+
+
+
+
+
+
+
+
+
+
+
+ );
+}
+
+const Wrapper = styled.div`
+ display: none;
+
+ ${mobile(css`
+ align-items: center;
+ display: flex;
+ flex-grow: 1;
+ height: ${rem(navbarHeight)};
+ justify-content: space-between;
+ margin-left: 16px;
+
+ > ${NavButton} {
+ margin-left: -8px;
+ }
+ `)};
+`;
+
+const SecondaryMenu = styled.div<{ $isOpen?: boolean }>`
+ position: absolute;
+ top: ${rem(navbarHeight)};
+ left: 0;
+ right: 0;
+
+ ${p =>
+ p.$isOpen
+ ? css`
+ height: ${rem(navbarHeight)};
+ `
+ : css`
+ height: 0;
+ `};
+ -webkit-overflow-scrolling: touch;
+ align-items: center;
+ background: rgba(33, 33, 33, 0.9);
+ backdrop-filter: blur(5px);
+ color: #fff;
+ display: flex;
+ flex-wrap: nowrap;
+ justify-content: center;
+ overflow-x: overlay;
+ overflow-y: hidden;
+ padding: 0 ${rem(20)};
+ transition: height 0.1s;
+ user-select: none;
+`;
+
+const ArrowWrapper = styled.div<{ $shouldRotate?: boolean }>`
+ transition: transform 0.2s;
+
+ ${p =>
+ p.$shouldRotate &&
+ css`
+ transform-origin: center center;
+ transform: rotate(180deg);
+ `};
+`;
+
+const StyledIcon = styled.div<{ $size?: number }>`
+ && {
+ width: ${p => rem(p.$size || 20)};
+ height: ${p => rem(p.$size || 20)};
+ }
+`;
diff --git a/apps/web/components/Nav/NavButton.tsx b/apps/web/components/Nav/NavButton.tsx
new file mode 100644
index 000000000..2764fd87a
--- /dev/null
+++ b/apps/web/components/Nav/NavButton.tsx
@@ -0,0 +1,30 @@
+import styled from 'styled-components';
+import { resetInput } from '../../utils/form';
+import rem from '../../utils/rem';
+import { navbarHeight } from '../../utils/sizes';
+
+const NavButton = styled.button`
+ ${resetInput};
+ background: transparent;
+ cursor: pointer;
+ flex: 0 0 auto;
+ height: ${rem(navbarHeight)};
+ padding: 0 ${rem(10)};
+ text-align: center;
+ transition: all 200ms ease-in-out;
+ vertical-align: middle;
+
+ &:hover {
+ filter: brightness(0.85);
+ }
+
+ &:active {
+ filter: brightness(1);
+ }
+
+ & + & {
+ padding-left: 0;
+ }
+`;
+
+export default NavButton;
diff --git a/apps/web/components/Nav/NavIcons.tsx b/apps/web/components/Nav/NavIcons.tsx
new file mode 100644
index 000000000..cad31a2b3
--- /dev/null
+++ b/apps/web/components/Nav/NavIcons.tsx
@@ -0,0 +1,56 @@
+import styled from 'styled-components';
+
+export const Svg = styled.svg`
+ svg {
+ display: inline-block;
+
+ path {
+ fill: currentColor;
+ }
+ }
+`;
+
+export const CloseIcon = () => (
+
+);
+
+export const FoldIcon = () => (
+
+);
+
+export const ArrowIcon = () => (
+
+);
+export const SearchIcon = () => (
+
+);
diff --git a/apps/web/components/Nav/NavLinks.tsx b/apps/web/components/Nav/NavLinks.tsx
new file mode 100644
index 000000000..b18219d1a
--- /dev/null
+++ b/apps/web/components/Nav/NavLinks.tsx
@@ -0,0 +1,45 @@
+import styled from 'styled-components';
+import rem from '../../utils/rem';
+import { navbarHeight } from '../../utils/sizes';
+import Link from '../Link';
+import NavSeparator from './NavSeparator';
+
+const Wrapper = styled.nav`
+ display: flex;
+ align-items: center;
+ flex: 0 0 auto;
+ margin-right: ${rem(30)};
+`;
+
+const NavLink = styled(Link).attrs((/* props */) => ({
+ unstyled: true,
+}))`
+ flex: 0 0 auto;
+ display: inline-block;
+ line-height: ${rem(navbarHeight)};
+ transition: opacity 0.2s, transform 0.2s;
+ cursor: pointer;
+
+ letter-spacing: ${rem(0.4)};
+ color: currentColor;
+
+ &:hover,
+ &:focus {
+ opacity: 0.8;
+ }
+
+ &:active {
+ transform: scale(0.95);
+ opacity: 0.6;
+ }
+`;
+
+const NavLinks = () => (
+
+ Documentation
+
+ Releases
+
+);
+
+export default NavLinks;
diff --git a/apps/web/components/Nav/NavSeparator.tsx b/apps/web/components/Nav/NavSeparator.tsx
new file mode 100644
index 000000000..98e146051
--- /dev/null
+++ b/apps/web/components/Nav/NavSeparator.tsx
@@ -0,0 +1,15 @@
+import styled from 'styled-components';
+import rem from '../../utils/rem';
+
+const NavSeparator = styled.span`
+ flex: 0 0 auto;
+ width: ${rem(5)};
+ height: ${rem(5)};
+ margin: 0 ${rem(15)};
+
+ border-radius: 50%;
+ background: currentColor;
+ opacity: 0.35;
+`;
+
+export default NavSeparator;
diff --git a/apps/web/components/Nav/Navbar.tsx b/apps/web/components/Nav/Navbar.tsx
new file mode 100644
index 000000000..c8d49b067
--- /dev/null
+++ b/apps/web/components/Nav/Navbar.tsx
@@ -0,0 +1,119 @@
+import styled, { css } from 'styled-components'
+import { mobile } from '../../utils/media'
+import rem from '../../utils/rem'
+import { navbarHeight } from '../../utils/sizes'
+import Link from '../Link'
+import MobileNavbar from './MobileNavbar'
+import NavLinks from './NavLinks'
+import Social from './Social'
+
+export interface NavbarProps {
+ onSideToggle?: () => void
+ onMobileNavToggle?: () => void
+ isSideFolded?: boolean
+ isMobileNavFolded?: boolean
+ showSideNav?: boolean
+}
+
+export default function Navbar({
+ onSideToggle,
+ onMobileNavToggle,
+ isSideFolded,
+ isMobileNavFolded,
+ showSideNav,
+}: NavbarProps) {
+ return (
+
+
+
+
+
+
+ MarkFlowy
+
+
+
+
+
+
+
+
+
+
+ )
+}
+
+const Wrapper = styled.nav<{ $transparent?: boolean }>`
+ align-items: center;
+ background-color: ${(props) => props.theme.navBackground};
+ backdrop-filter: blur(5px);
+ -webkit-backdrop-filter: blur(5px);
+ box-sizing: border-box;
+ color: white;
+ display: flex;
+ flex-wrap: wrap;
+ font-family: ${(props) => props.theme.fontFamily};
+ font-size: ${rem(15)};
+ font-weight: 500;
+ justify-content: center;
+ height: ${rem(navbarHeight)};
+ left: 0;
+ padding: 0;
+ position: fixed;
+ transition: background 300ms ease-out;
+ width: 100%;
+ z-index: 3;
+`
+
+const StartWrapper = styled.div`
+ display: flex;
+ align-items: center;
+ justify-content: flex-start;
+`
+
+const EndWrapper = styled.div`
+ display: flex;
+ align-items: center;
+ justify-content: flex-end;
+`
+/* stylelint-disable */
+const StyledSocial = styled(Social)``
+/* stylelint-enable */
+
+const NormalNavbar = styled.div`
+ display: flex;
+ align-items: center;
+ padding: 0 ${rem(20)};
+ justify-content: space-between;
+
+ ${StartWrapper}, ${EndWrapper} ${StyledSocial} {
+ ${mobile(css`
+ display: none;
+ `)};
+ }
+`
+
+const LogoLink = styled(Link).attrs((/* props */) => ({
+ unstyled: true,
+ href: '/',
+}))`
+ display: inline-block;
+ vertical-align: center;
+ margin-right: ${rem(35)};
+`
diff --git a/apps/web/components/Nav/Sidebar.tsx b/apps/web/components/Nav/Sidebar.tsx
new file mode 100644
index 000000000..63995fd18
--- /dev/null
+++ b/apps/web/components/Nav/Sidebar.tsx
@@ -0,0 +1,40 @@
+import styled, { css } from 'styled-components';
+import { paleGrey } from '../../utils/colors';
+import { mobile } from '../../utils/media';
+import rem from '../../utils/rem';
+import { navbarHeight, sidebarWidth } from '../../utils/sizes';
+import captureScroll from '../CaptureScroll';
+
+export interface SidebarProps {
+ $isFolded?: boolean;
+}
+
+const Sidebar = styled.nav`
+ position: fixed;
+ transform: translateZ(0);
+ display: block;
+ z-index: 1;
+ font-family: ${props => props.theme.fontFamily};
+
+ left: 0;
+ top: ${rem(navbarHeight)};
+ bottom: 0;
+ right: auto;
+ width: ${rem(sidebarWidth)};
+ background: ${props => props.theme.sidebarBackground};
+ box-sizing: border-box;
+ color: inherit;
+ overflow-y: auto;
+ transition: transform 150ms ease-out;
+
+ ${mobile(css`
+ ${p =>
+ p.$isFolded
+ ? css`
+ transform: translateX(${rem(-sidebarWidth)});
+ `
+ : ``};
+ `)};
+`;
+
+export default captureScroll(Sidebar);
diff --git a/apps/web/components/Nav/SidebarMenus.tsx b/apps/web/components/Nav/SidebarMenus.tsx
new file mode 100644
index 000000000..ec4f810c3
--- /dev/null
+++ b/apps/web/components/Nav/SidebarMenus.tsx
@@ -0,0 +1,89 @@
+import styled from 'styled-components'
+import rem from '../../utils/rem'
+import { StyledLink } from '../Link'
+import { getSections } from 'utils/sections'
+
+export interface SimpleSidebarMenuProps {
+ pages?: { title: string; pathname: string; sections: { title: string }[]; href: string }[]
+}
+
+export const SimpleSidebarMenu = () => {
+ const sections = getSections()
+ const keys = Object.keys(sections)
+ return (
+
+ {keys.map((key) => {
+ const section = sections[key]
+ return (
+
+
+ {key}
+
+
+ {section.map(({ slug, title }) => {
+ return (
+
+ {title}
+
+ )
+ })}
+
+ )
+ })}
+
+ )
+}
+
+const MenuInner = styled.div`
+ display: block;
+ box-sizing: border-box;
+ height: 100%;
+ padding-top: ${rem(60)};
+`
+
+const Section = styled.div`
+ margin-bottom: ${rem(20)};
+`
+
+const SectionTitle = styled.h4`
+ display: block;
+ margin: ${rem(10)} ${rem(40)};
+`
+
+const SubSection = styled.h5`
+ display: block;
+ margin: ${rem(10)} ${rem(40)} ${rem(10)} ${rem(55)};
+ font-size: 0.9rem;
+ font-weight: normal;
+`
+
+export interface DocsSidebarMenuProps {}
+
+export const DocsSidebarMenu = () => {
+ const sections = getSections()
+ const keys = Object.keys(sections)
+
+ return (
+
+ {keys.map((key) => {
+ const section = sections[key]
+
+ return (
+
+
+ {key}
+
+
+ {section.map(({ slug, title }) => {
+ return (
+
+ {title}
+
+ )
+ })}
+
+ )
+ })}
+
+ )
+}
diff --git a/apps/web/components/Nav/Social.tsx b/apps/web/components/Nav/Social.tsx
new file mode 100644
index 000000000..ae5f17010
--- /dev/null
+++ b/apps/web/components/Nav/Social.tsx
@@ -0,0 +1,59 @@
+import React from 'react';
+import styled from 'styled-components';
+import { Github } from '@styled-icons/fa-brands/Github/Github';
+import rem from '../../utils/rem';
+import { navbarHeight } from '../../utils/sizes';
+import Link from '../Link';
+
+const Wrapper = styled.nav`
+ display: flex;
+ align-items: center;
+ flex: 1 1 auto;
+`;
+
+const SocialLink = styled(Link).attrs((/* props */) => ({
+ unstyled: true,
+}))`
+ display: flex;
+ margin-right: ${rem(20)};
+ line-height: ${rem(navbarHeight)};
+ transition: opacity 0.2s, transform 0.2s;
+ cursor: pointer;
+
+ &:last-child {
+ margin-right: 0;
+ }
+
+ &:hover,
+ &:focus {
+ opacity: 0.8;
+ }
+
+ &:active {
+ transform: scale(0.95);
+ opacity: 0.6;
+ }
+
+ svg {
+ path {
+ fill: currentColor;
+ }
+ }
+`;
+
+const StyledIcon = styled.div<{ $height?: number; $width?: number }>`
+ && {
+ width: ${p => rem(Number(p.$width))};
+ height: ${p => rem(Number(p.$height))};
+ }
+`;
+
+const Social = (props: React.ComponentProps) => (
+
+
+
+
+
+);
+
+export default Social;
diff --git a/apps/web/components/Nav/Text.tsx b/apps/web/components/Nav/Text.tsx
new file mode 100644
index 000000000..1f2097fa4
--- /dev/null
+++ b/apps/web/components/Nav/Text.tsx
@@ -0,0 +1,16 @@
+import styled, { css } from 'styled-components';
+import { mobile } from '../../utils/media';
+import rem from '../../utils/rem';
+
+const Text = styled.div`
+ display: none;
+ margin-left: ${rem(15)};
+ margin-top: ${rem(5)};
+ font-size: ${rem(18)};
+
+ ${mobile(css`
+ display: block;
+ `)};
+`;
+
+export default Text;
diff --git a/apps/web/components/Nav/index.tsx b/apps/web/components/Nav/index.tsx
new file mode 100644
index 000000000..d5ab7f848
--- /dev/null
+++ b/apps/web/components/Nav/index.tsx
@@ -0,0 +1,46 @@
+import React from 'react'
+import Navbar from './Navbar'
+import Sidebar from './Sidebar'
+import { DocsSidebarMenu, SimpleSidebarMenu, SimpleSidebarMenuProps } from './SidebarMenus'
+
+export interface NavProps {
+ isSideFolded?: boolean
+ isMobileNavFolded?: boolean
+ onSideToggle?: () => void
+ onMobileNavToggle?: () => void
+ showSideNav?: boolean
+ useDocsSidebarMenu?: boolean
+ pages?: SimpleSidebarMenuProps['pages']
+}
+
+const Nav = (props: NavProps) => {
+ const {
+ isSideFolded,
+ isMobileNavFolded,
+ onSideToggle,
+ onMobileNavToggle,
+ showSideNav,
+ useDocsSidebarMenu,
+ pages,
+ } = props
+
+ return (
+
+
+
+ {showSideNav !== false && (
+
+ {useDocsSidebarMenu !== false ? : }
+
+ )}
+
+ )
+}
+
+export default Nav
diff --git a/apps/web/components/NextPage.tsx b/apps/web/components/NextPage.tsx
new file mode 100644
index 000000000..b1a4a8a09
--- /dev/null
+++ b/apps/web/components/NextPage.tsx
@@ -0,0 +1,62 @@
+import { KeyboardArrowRight } from '@styled-icons/material/KeyboardArrowRight/KeyboardArrowRight'
+import styled, { css } from 'styled-components'
+import { grey } from '../utils/colors'
+import { mobile } from '../utils/media'
+import rem from '../utils/rem'
+import Link, { LinkProps } from './Link'
+
+const Wrapper = styled(Link).attrs((/* props */) => ({
+ unstyled: true,
+}))`
+ display: flex;
+ flex-direction: row;
+ align-items: stretch;
+ justify-content: flex-end;
+
+ width: 100%;
+ padding: ${rem(40)} ${rem(20)};
+ text-align: right;
+ font-family: ${(props) => props.theme.fontFamily};
+
+ ${mobile(css`
+ text-align: left;
+ justify-content: center;
+ padding: ${rem(30)} ${rem(20)};
+ `)};
+`
+
+const Text = styled.h3`
+ font-weight: normal;
+ padding-right: ${rem(20)};
+ margin: 0;
+`
+
+const PageName = styled.h2`
+ font-weight: 600;
+ padding-right: ${rem(20)};
+ margin: 0;
+`
+
+const Icon = styled(KeyboardArrowRight)`
+ color: ${grey};
+ width: ${rem(30)};
+`
+
+export interface NextPageProps extends Pick {
+ title: string
+}
+
+const NextPage = ({ title, href }: NextPageProps) => (
+
+
+
Continue on the next page
+
{title}
+
+
+
+
+)
+
+export default NextPage
diff --git a/apps/web/components/SeoHead.tsx b/apps/web/components/SeoHead.tsx
new file mode 100644
index 000000000..5ad5b2065
--- /dev/null
+++ b/apps/web/components/SeoHead.tsx
@@ -0,0 +1,49 @@
+import NextHead from 'next/head';
+
+export interface SeoHeadProps {
+ canonical?: string;
+ description?: string;
+ image?: string;
+ title?: string;
+ url?: string;
+}
+
+export default function SeoHead({
+ canonical,
+ children,
+ description = 'Modern Markdown editor.',
+ image = 'https://www.styled-components.com/atom.png',
+ title = 'MarkFlowy',
+ url = '',
+}: React.PropsWithChildren) {
+ const properCanonical = canonical || url;
+
+ return (
+
+ {title}
+
+
+
+ {/* Open Graph */}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ {children}
+
+
+
+
+ );
+}
diff --git a/apps/web/components/ThemeProvider.tsx b/apps/web/components/ThemeProvider.tsx
new file mode 100644
index 000000000..7fbce8861
--- /dev/null
+++ b/apps/web/components/ThemeProvider.tsx
@@ -0,0 +1,13 @@
+import { ThemeProvider as StyledThemeProvider } from 'styled-components'
+import { darkTheme } from 'theme'
+import React from 'react'
+
+type ThemeProviderProps = {
+ children?: React.ReactNode
+}
+
+const ThemeProvider: React.FC = ({ children }) => (
+ {children}
+)
+
+export default ThemeProvider
diff --git a/apps/web/contentlayer.config.js b/apps/web/contentlayer.config.js
new file mode 100644
index 000000000..6ec19e780
--- /dev/null
+++ b/apps/web/contentlayer.config.js
@@ -0,0 +1,86 @@
+import { defineDocumentType, makeSource } from 'contentlayer2/source-files'
+import remarkGfm from 'remark-gfm'
+import rehypeSlug from 'rehype-slug'
+
+export const Post = defineDocumentType(() => ({
+ name: 'Post',
+ contentType: 'mdx',
+ // Location of Post source files (relative to `contentDirPath`)
+ filePathPattern: '/*.mdx',
+ // At the time of writing, we also have to define the `fields`
+ // option to prevent an error on generation. We'll discuss
+ // this option later. For now, we'll add an empty object.
+ fields: {},
+ computedFields: {
+ slug: {
+ type: 'string',
+ resolve: (doc) => {
+ return doc._raw.flattenedPath
+ },
+ },
+ // excerpt: {
+ // type: "string",
+ // resolve: (post) =>
+ // post.tldr ? post.tldr : parseMarkdown(post.body.raw, 155),
+ // },
+ // description: {
+ // type: "string",
+ // resolve: (post) => parseMarkdown(post.body.raw, 300),
+ // },
+ // timetoread: {
+ // type: "number",
+ // resolve: (post) => parseReadTime(post.body.raw)
+ // }
+ },
+}))
+
+export const Markdown = defineDocumentType(() => ({
+ name: 'Markdown',
+ contentType: 'markdown',
+ // Location of Post source files (relative to `contentDirPath`)
+ filePathPattern: './**/*.md',
+ // At the time of writing, we also have to define the `fields`
+ // option to prevent an error on generation. We'll discuss
+ // this option later. For now, we'll add an empty object.
+ fields: {},
+ computedFields: {
+ slug: {
+ type: 'string',
+ resolve: (doc) => {
+ return doc._raw.flattenedPath
+ },
+ },
+ title: {
+ type: 'string',
+ resolve: (doc) => {
+ return doc._raw.sourceFileName.split('.md')?.[0]
+ },
+ }
+ // excerpt: {
+ // type: "string",
+ // resolve: (post) =>
+ // post.tldr ? post.tldr : parseMarkdown(post.body.raw, 155),
+ // },
+ // description: {
+ // type: "string",
+ // resolve: (post) => parseMarkdown(post.body.raw, 300),
+ // },
+ // timetoread: {
+ // type: "number",
+ // resolve: (post) => parseReadTime(post.body.raw)
+ // }
+ },
+}))
+
+export default makeSource({
+ contentDirPath: '../../docs',
+ documentTypes: [Post, Markdown],
+ mdx: {
+ esbuildOptions(options) {
+ options.target = 'esnext'
+ return options
+ },
+ remarkPlugins: [remarkGfm],
+ rehypePlugins: [rehypeSlug],
+ },
+})
diff --git a/apps/web/global.d.ts b/apps/web/global.d.ts
new file mode 100644
index 000000000..8b37298ef
--- /dev/null
+++ b/apps/web/global.d.ts
@@ -0,0 +1,11 @@
+import { CSSProp, StyledObject } from 'styled-components';
+
+interface EventListenerOptions {
+ passive?: boolean;
+}
+
+declare module 'react' {
+ interface DOMAttributes {
+ css?: string | StyledObject;
+ }
+}
diff --git a/apps/web/hooks/useTheme.tsx b/apps/web/hooks/useTheme.tsx
new file mode 100644
index 000000000..120c0b487
--- /dev/null
+++ b/apps/web/hooks/useTheme.tsx
@@ -0,0 +1,4 @@
+
+
+export const useTheme = () => {
+}
diff --git a/apps/web/next-env.d.ts b/apps/web/next-env.d.ts
new file mode 100644
index 000000000..a4a7b3f5c
--- /dev/null
+++ b/apps/web/next-env.d.ts
@@ -0,0 +1,5 @@
+///
+///
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
diff --git a/apps/web/next-i18next.config.js b/apps/web/next-i18next.config.js
new file mode 100644
index 000000000..1d01ee38f
--- /dev/null
+++ b/apps/web/next-i18next.config.js
@@ -0,0 +1,28 @@
+// @ts-check
+
+/**
+ * @type {import('next-i18next').UserConfig}
+ */
+module.exports = {
+ // https://www.i18next.com/overview/configuration-options#logging
+ debug: process.env.NODE_ENV === 'development',
+ i18n: {
+ defaultLocale: 'en',
+ locales: ['en', 'cn', 'fr'],
+ },
+ /** To avoid issues when deploying to some paas (vercel...) */
+ localePath:
+ typeof window === 'undefined'
+ ? require('path').resolve('../../locales')
+ : '../../locales',
+
+ reloadOnPrerender: process.env.NODE_ENV === 'development',
+
+ /**
+ * @link https://github.com/i18next/next-i18next#6-advanced-configuration
+ */
+ // saveMissing: false,
+ // strictMode: true,
+ // serializeConfig: false,
+ // react: { useSuspense: false }
+}
diff --git a/apps/web/next.config.js b/apps/web/next.config.js
new file mode 100644
index 000000000..2fb5369b3
--- /dev/null
+++ b/apps/web/next.config.js
@@ -0,0 +1,20 @@
+const { withContentlayer } = require('next-contentlayer2')
+const { i18n } = require('./next-i18next.config.js')
+const withSvgr = require('@newhighsco/next-plugin-svgr')
+
+/**
+ * @type {import('next').NextConfig}
+ */
+
+module.exports = withSvgr(
+ withContentlayer({
+ compiler: {
+ styledComponents: true,
+ styledJsx: true
+ },
+ i18n,
+ experimental: {
+ output: 'standalone',
+ },
+ }),
+)
diff --git a/apps/web/next__mdx.d.ts b/apps/web/next__mdx.d.ts
new file mode 100644
index 000000000..3779b4132
--- /dev/null
+++ b/apps/web/next__mdx.d.ts
@@ -0,0 +1,14 @@
+import { NextConfig } from 'next';
+
+declare module '@next/mdx' {
+ interface WithMDXConfig {
+ extension?: RegExp;
+ options?: {
+ providerImportSource?: string;
+ remarkPlugins: any[];
+ rehypePlugins?: any[];
+ };
+ }
+
+ export default function WithMDX(config: WithMDXConfig): (config: NextConfig) => NextConfig;
+}
diff --git a/apps/web/package.json b/apps/web/package.json
new file mode 100644
index 000000000..78b3aba20
--- /dev/null
+++ b/apps/web/package.json
@@ -0,0 +1,70 @@
+{
+ "name": "@markflowy/web",
+ "version": "0.0.1",
+ "license": "MIT",
+ "private": true,
+ "scripts": {
+ "analyze": "ANALYZE=true yarn build",
+ "dev": "next dev",
+ "prebuild": "rimraf .next",
+ "precommit": "lint-staged",
+ "build": "NODE_ENV=production next build",
+ "start": "NODE_ENV=production next start",
+ "prettier": "prettier --write \"**/*.*\""
+ },
+ "dependencies": {
+ "@apollo/client": "^3.11.8",
+ "@mdx-js/loader": "^3.1.0",
+ "@mdx-js/mdx": "^3.1.0",
+ "@mdx-js/react": "^3.1.0",
+ "@newhighsco/next-plugin-svgr": "^3.0.144",
+ "@next/mdx": "^14.2.3",
+ "@styled-icons/fa-brands": "^10.47.0",
+ "@styled-icons/material": "^10.47.0",
+ "@swc/helpers": "^0.5.15",
+ "contentlayer2": "0.5.2",
+ "isomorphic-fetch": "^3.0.0",
+ "markdown-to-jsx": "^7.5.0",
+ "next": "^14.2.14",
+ "next-contentlayer2": "0.5.2",
+ "next-i18next": "^15.3.0",
+ "polished": "^4.3.1",
+ "react": "18.3.1",
+ "react-dom": "18.3.1",
+ "react-is": "18.3.1",
+ "rehype-slug": "^6.0.0",
+ "rme": "0.1.0-beta.7",
+ "styled-components": "^6.1.13",
+ "styled-jsx": "^5.1.6",
+ "stylis": "^4.3.4",
+ "stylis-plugin-rtl": "^2.1.1",
+ "zens": "0.0.42"
+ },
+ "devDependencies": {
+ "@octokit/types": "^13.6.1",
+ "@types/enzyme": "^3.10.18",
+ "@types/mdx": "^2.0.13",
+ "@types/node": "^22.8.6",
+ "@types/react": "18.3.12",
+ "@types/react-dom": "18.3.1",
+ "@types/react-test-renderer": "^18.3.0",
+ "@types/react-transition-group": "^4.4.11",
+ "@types/styled-theming": "^2.2.8",
+ "@types/webpack-bundle-analyzer": "^4.7.0",
+ "@types/zeit__next-source-maps": "^0.0.5",
+ "csstype": "^3.1.3",
+ "enzyme": "^3.11.0",
+ "enzyme-to-json": "^3.6.2",
+ "lint-staged": "^15.2.10",
+ "prettier": "^3.3.3",
+ "react-test-renderer": "^18.3.1",
+ "remark-gfm": "^4.0.0",
+ "rimraf": "^6.0.1",
+ "typescript": "^5.6.3",
+ "webpack-bundle-analyzer": "^4.10.2"
+ },
+ "resolutions": {
+ "@types/react": "18.3.12",
+ "@types/react-dom": "18.3.1"
+ }
+}
diff --git a/apps/web/pages/_app.tsx b/apps/web/pages/_app.tsx
new file mode 100644
index 000000000..a3ab617db
--- /dev/null
+++ b/apps/web/pages/_app.tsx
@@ -0,0 +1,97 @@
+import App from 'next/app'
+import Head from 'next/head'
+import { createGlobalStyle } from 'styled-components'
+import { darkTheme, lightTheme } from 'theme'
+import './normalize.css'
+import ThemeProvider from 'components/ThemeProvider'
+
+
+export default class MyApp extends App {
+ render() {
+ const { Component, pageProps } = this.props
+
+ return (
+ <>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ )
+ }
+}
+
+const ResetStyles = createGlobalStyle`
+ *,::after,::before{background-repeat:no-repeat;box-sizing:inherit}::after,::before{text-decoration:inherit;vertical-align:inherit}html{box-sizing:border-box;cursor:default;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}article,aside,footer,header,nav,section{display:block}body{margin:0}h1{font-size:2em;margin:.67em 0}figcaption,figure,main{display:block}figure{margin:1em 40px}hr{box-sizing:content-box;height:0;overflow:visible}nav ol,nav ul{list-style:none}pre{font-family:monospace,monospace;font-size:1em}a{text-decoration:none;color:inherit;background-color:transparent;-webkit-text-decoration-skip:objects}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:inherit}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}dfn{font-style:italic}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}audio,canvas,iframe,img,svg,video{vertical-align:middle}audio,video{display:inline-block}audio:not([controls]){display:none;height:0}img{border-style:none}svg:not(:root){overflow:hidden}table{border-collapse:collapse}button,input,optgroup,select,textarea{margin:0}button,input,select,textarea{background-color:transparent;color:inherit;font-size:inherit;line-height:inherit}button,input{overflow:visible}button,select{text-transform:none}[type=reset],[type=submit],button,html [type=button]{-webkit-appearance:button; cursor: pointer}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{display:inline-block;vertical-align:baseline}textarea{overflow:auto;resize:vertical}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-cancel-button,[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details,menu{display:block}summary{display:list-item}canvas{display:inline-block}template{display:none}[tabindex],a,area,button,input,label,select,summary,textarea{-ms-touch-action:manipulation;touch-action:manipulation}[hidden]{display:none}[aria-busy=true]{cursor:progress}[aria-controls]{cursor:pointer}[aria-hidden=false][hidden]:not(:focus){clip:rect(0,0,0,0);display:inherit;position:absolute}[aria-disabled]{cursor:default}
+
+ #__next {
+ overflow-x: hidden;
+ }
+
+ html, body {
+ font-size: 16px;
+ line-height: 1.6;
+ font-family: ${(props) => props.theme.fontFamily};
+ font-variant-ligatures: common-ligatures;
+ font-style: normal;
+ padding: 0;
+ margin: 0;
+ color: ${(props) => props.theme.primaryFontColor};
+ background-color: ${(props) => props.theme.bgColor};
+ -webkit-font-smoothing: subpixel-antialiased;
+ }
+
+ body.sticky {
+ overflow: hidden;
+ }
+
+ .root {
+ position: relative;
+ overflow: auto;
+ }
+
+ .small {
+ color: white;
+ font-size: 0.5em;
+ }
+
+ .big {
+ color: white;
+ font-size: 1.4em;
+ }
+
+ strong {
+ font-weight: 600;
+ }
+
+
+ ::selection {
+ background: rgba(245, 184, 61, 0.25);
+ }
+
+ @media all and (max-width: 1000px) {
+ html, body {
+ font-size: 16px;
+ }
+
+ }
+`
diff --git a/apps/web/pages/_document.tsx b/apps/web/pages/_document.tsx
new file mode 100644
index 000000000..c465ada04
--- /dev/null
+++ b/apps/web/pages/_document.tsx
@@ -0,0 +1,52 @@
+import Footer from 'components/Footer'
+import ThemeProvider from 'components/ThemeProvider'
+import Document, { DocumentContext, Head, Html, Main, NextScript } from 'next/document'
+import { ServerStyleSheet } from 'styled-components'
+import { darkTheme } from 'theme'
+
+export default class MyDocument extends Document {
+ static async getInitialProps(ctx: DocumentContext) {
+ const sheet = new ServerStyleSheet()
+ const originalRenderPage = ctx.renderPage
+
+ try {
+ ctx.renderPage = () =>
+ originalRenderPage({
+ enhanceApp: (App) => (props) => sheet.collectStyles(),
+ })
+
+ const initialProps = await Document.getInitialProps(ctx)
+ return {
+ ...initialProps,
+ styles: [initialProps.styles, sheet.getStyleElement()],
+ }
+ } finally {
+ sheet.seal()
+ }
+ }
+
+ render() {
+ return (
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ )
+ }
+}
diff --git a/apps/web/pages/docs.json b/apps/web/pages/docs.json
new file mode 100644
index 000000000..7a180d844
--- /dev/null
+++ b/apps/web/pages/docs.json
@@ -0,0 +1,24 @@
+{
+ "pages": [
+ {
+ "title": "Basics",
+ "pathname": "basics",
+ "sections": [
+ {
+ "pathname": "motivation",
+ "title": "Motivation"
+ }
+ ]
+ },
+ {
+ "title": "API Reference",
+ "pathname": "api",
+ "sections": [
+ {
+ "pathname": "typescript",
+ "title": "typescript"
+ }
+ ]
+ }
+ ]
+}
diff --git a/apps/web/pages/docs/[...slug].tsx b/apps/web/pages/docs/[...slug].tsx
new file mode 100644
index 000000000..6790b41d8
--- /dev/null
+++ b/apps/web/pages/docs/[...slug].tsx
@@ -0,0 +1,32 @@
+import { allMarkdowns } from 'contentlayer/generated'
+import { useRouter } from 'next/router'
+import DocsLayout from '../../components/DocsLayout'
+import dynamic from 'next/dynamic'
+import Loading from 'components/Loading'
+import 'prosemirror-flat-list/dist/style.css'
+
+const DynamicThemeProvider = dynamic(() => import('../../components/MdHtmlWrapper'), {
+ ssr: false,
+ loading: () => ,
+})
+
+const PostLayout = () => {
+ const router = useRouter()
+ const slug = Array.isArray(router.query?.slug) ? router.query.slug.join('/') : ''
+
+ const markdown = allMarkdowns.find((markdown) => markdown._raw.flattenedPath === slug)
+
+ if (markdown) {
+ return (
+
+
+
+ )
+ } else {
+ return not found
+ }
+}
+
+export default PostLayout
diff --git a/apps/web/pages/docs/index.tsx b/apps/web/pages/docs/index.tsx
new file mode 100644
index 000000000..3ad42b896
--- /dev/null
+++ b/apps/web/pages/docs/index.tsx
@@ -0,0 +1,70 @@
+import styled, { css } from 'styled-components'
+import DocsLayout from '../../components/DocsLayout'
+import { Header } from '../../components/Layout'
+import Link from '../../components/Link'
+import { mobile, phone } from '../../utils/media'
+import rem from '../../utils/rem'
+import { getSections } from 'utils/sections'
+
+export default function Documentation() {
+ const sections = getSections()
+ const keys = Object.keys(sections)
+
+ return (
+
+
+ {keys.map((key) => {
+ const section = sections[key]
+ return (
+
+
+
+ {section.map(({ slug, title }) => {
+ return (
+
+ {title}
+
+ )
+ })}
+
+ )
+ })}
+
+
+ )
+}
+
+const Row = styled.div`
+ display: flex;
+ flex-flow: row wrap;
+`
+
+const Column = styled.div`
+ width: 33%;
+ max-width: 33%;
+ flex-basis: 33%;
+ padding-right: ${rem(15)};
+
+ ${mobile(css`
+ width: 50%;
+ max-width: 50%;
+ flex-basis: 50%;
+ `)} ${phone(css`
+ width: 100%;
+ max-width: 100%;
+ flex-basis: 100%;
+ `)};
+`
+
+const SubHeader = styled.h3`
+ display: block;
+ margin: ${rem(8)} 0;
+ font-size: ${rem(18)};
+ font-weight: normal;
+ font-family: ${(props) => props.theme.fontFamily};
+`
diff --git a/apps/web/pages/index.tsx b/apps/web/pages/index.tsx
new file mode 100644
index 000000000..9244da34a
--- /dev/null
+++ b/apps/web/pages/index.tsx
@@ -0,0 +1,156 @@
+import React, { useEffect, useState } from 'react'
+import styled, { css } from 'styled-components'
+import Footer from '../components/Footer'
+import { Content } from '../components/Layout'
+import Nav from '../components/Nav'
+import SeoHead from '../components/SeoHead'
+import rem from '../utils/rem'
+import Feature from 'components/Feature'
+
+export default function Index() {
+ const [isMobileNavFolded, setIsMobileNavFolded] = React.useState(true)
+ return (
+ <>
+
+
+
+
+