archive notice

https://github.com/yaml/pyyaml/issues/601

.gitignore

@@ -1,2 +1,5 @@
 *.swp
 env
+n
+web
+__pycache__

LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

Makefile

@@ -1,9 +1,16 @@
 install:
-	cp notes2web.py /usr/local/bin
-	pip install -r requirements.txt
+	cp  n2w_add_uuid.py /usr/local/bin
+	sed "s/N2W_COMMIT = \"\"/N2W_COMMIT = \"$$(git rev-parse --short HEAD)\"/" notes2web.py > /usr/local/bin/notes2web.py
+	pip3 install -r requirements.txt --break-system-packages
 	mkdir -p /opt/notes2web
 	cp -r templates /opt/notes2web
 	cp styles.css /opt/notes2web
+	cp fuse.js /opt/notes2web
+	cp search.js /opt/notes2web
+	cp indexsearch.js /opt/notes2web
+	cp toc_search.js /opt/notes2web
+	cp permalink.js /opt/notes2web
+	chmod +x /usr/local/bin/notes2web.py
 
 uninstall:
-	rm -rf /usr/local/bin/notes2web.py /opt/notes2web
+	rm -rf /usr/local/bin/notes2web.py /usr/local/bin/n2w_add_uuid.py /opt/notes2web

indexsearch.js

@@ -0,0 +1,75 @@
+const HEADERS = "headers"
+const PATH = "path"
+const TAGS = "tags"
+const TITLE = "title"
+
+const SEARCH_TIMEOUT_MS = 100
+var SEARCH_TIMEOUT_ID = -1
+
+const fuse = new Fuse(data, {
+  keys: [ 'title' ],
+  ignoreLocation: true,
+  threshhold: 0.4,
+  minMatchCharLength: 0,
+})
+
+const RESULTS_MAX = 15
+
+const searchBar = document.getElementById('search')
+const resultsDiv = document.getElementById('searchResults')
+
+var results = []
+
+function updateResultsWithTimeout() {
+  console.log("clearing timeout")
+  if (SEARCH_TIMEOUT_ID) SEARCH_TIMEOUT_ID = clearTimeout(SEARCH_TIMEOUT_ID)
+  SEARCH_TIMEOUT_ID = setTimeout(updateResults, SEARCH_TIMEOUT_MS)
+}
+
+function updateResults() {
+  console.log("updating results")
+  resultsDiv.innerHTML = ''
+  if (searchBar.value) results = fuse.search(searchBar.value, { limit: RESULTS_MAX }).map(r => r.item)
+  else results = data
+
+  results.forEach(r => {
+    wrapper = document.createElement('li')
+    wrapper.className = "article"
+
+    atag = document.createElement('a')
+    atag.href = r.path
+
+    ptag = document.createElement('p')
+    ptag.innerHTML = r.title + (r.isdirectory ? '/' : '')
+
+    atag.appendChild(ptag)
+    wrapper.appendChild(atag)
+    resultsDiv.appendChild(wrapper)
+  })
+}
+
+searchBar.addEventListener('keyup', e => {
+  console.log(e)
+  // if user pressed enter
+  if (e.keyCode === 13) {
+    if (e.shiftKey) {
+      window.open(results[0].path, '_blank')
+    } else {
+    window.location.href = results[0].path
+    }
+    return
+  }
+  updateResultsWithTimeout()
+})
+
+searchBar.addEventListener('change', updateResultsWithTimeout)
+
+const searchParams = new URL(window.location.href).searchParams;
+searchBar.value = searchParams.get('q');
+updateResults();
+
+console.log(results)
+
+if (searchParams.has('lucky')) {
+  window.location.href = results[0].path;
+}

n2w_add_uuid.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+
+import editfrontmatter
+import frontmatter
+import pathlib
+import sys
+import uuid
+
+def get_args():
+    """ Get command line arguments """
+
+    import argparse
+    parser = argparse.ArgumentParser()
+    parser.add_argument('filename', type=pathlib.Path)
+    parser.add_argument('--template',
+            default=pathlib.Path("/opt/notes2web/templates/n2w_add_uuid_frontmatter_template"),
+            type=pathlib.Path
+    )
+    parser.add_argument('-w', '--write', action='store_true',
+            help='write to file instead of stdout')
+    return parser.parse_args()
+
+
+def main(args):
+    """ Entry point for script """
+    with open(args.template) as fp:
+        template_str=fp.read()
+
+    with open(args.filename) as fp:
+        fm_pre = frontmatter.load(fp)
+
+    processor = editfrontmatter.EditFrontMatter(file_path=args.filename, template_str=template_str)
+    fm_data = fm_pre.metadata
+    if 'uuid' not in fm_data.keys():
+        fm_data['uuid'] = str(uuid.uuid4())
+
+    processor.run(fm_data)
+
+    if args.write:
+        with open(args.filename, 'w') as fp:
+            fp.write(processor.dumpFileData())
+    else:
+        print(processor.dumpFileData())
+    return 0
+
+
+if __name__ == '__main__':
+    try:
+        sys.exit(main(get_args()))
+    except KeyboardInterrupt:
+        sys.exit(0)

notes2web.py

@@ -2,13 +2,18 @@
 
 
 from bs4 import BeautifulSoup as bs
+import subprocess
+import frontmatter
 import magic
 import sys
 import pathlib
 import pypandoc
 import shutil
 import os
-import re
+import regex as re
+import json
+import yaml
+
 
 TEXT_ARTICLE_TEMPLATE_FOOT = None
 TEXT_ARTICLE_TEMPLATE_HEAD = None
@@ -16,6 +21,12 @@ INDEX_TEMPLATE_FOOT = None
 INDEX_TEMPLATE_HEAD = None
 EXTRA_INDEX_CONTENT = None
 
+N2W_COMMIT = ""
+
+
+def is_plaintext(filename):
+    return re.match(r'^text/', magic.from_file(str(filename), mime=True)) is not None
+
 def get_files(folder):
     markdown = []
     plaintext = []
@@ -23,10 +34,12 @@ def get_files(folder):
 
     for root, folders, files in os.walk(folder):
         for filename in files:
+            if '/.git' in root:
+                continue
             name = os.path.join(root, filename)
-            if os.path.splitext(name)[1] == '.md':
+            if pathlib.Path(name).suffix == '.md':
                 markdown.append(name)
-            elif re.match(r'^text/', magic.from_file(name, mime=True)):
+            elif is_plaintext(name):
                 plaintext.append(name)
                 other.append(name)
             else:
@@ -34,15 +47,92 @@ def get_files(folder):
 
     return markdown, plaintext, other
 
-def get_dirs(folder):
+def get_inherited_tags(file, base_folder):
+    tags = []
+    folder = pathlib.Path(file)
+
+    while folder != base_folder.parent:
+        print(f"get_inherited_tags {folder=}")
+        folder = pathlib.Path(folder).parent
+        folder_metadata = folder.joinpath('.n2w.yml')
+        if not folder_metadata.exists():
+            continue
+
+        with open(folder.joinpath('.n2w.yml')) as fp:
+            folder_properties = yaml.safe_load(fp)
+
+        tags += folder_properties.get('itags')
+
+    print(f"get_inherited_tags {tags=}")
+    return list(set(tags))
+
+
+def git_head_sha1(working_dir):
+    git_response = subprocess.run(
+            [ 'git', f"--git-dir={working_dir.joinpath('.git')}", 'rev-parse', '--short', 'HEAD' ],
+            stdout=subprocess.PIPE
+    ).stdout.decode('utf-8')
+
+    return git_response.strip()
+
+
+def git_filehistory(working_dir, filename):
+    print(f"{pathlib.Path(filename).relative_to(working_dir)=}")
+    git_response = subprocess.run(
+            [
+                'git',
+                f"--git-dir={working_dir.joinpath('.git')}",
+                "log",
+                "-p",
+                "--",
+                pathlib.Path(filename).relative_to(working_dir)
+            ],
+            stdout=subprocess.PIPE
+    )
+
+    filehistory = [f"File history not available: git log returned code {git_response.returncode}."
+    "\nIf this is not a git repository, this is not a problem."]
+
+    if git_response.returncode == 0:
+        filehistory = git_response.stdout.decode('utf-8')
+        temp = re.split(
+                r'(commit [a-f0-9]{40})',
+                filehistory,
+                flags=re.IGNORECASE
+        )
+
+        for t in temp:
+            if t == '':
+                temp.remove(t)
+        filehistory = []
+        for i in range(0, len(temp)-1, 2):
+            filehistory.append(f"{temp[i]}{temp[i+1]}")
+
+    if filehistory == "":
+        filehistory = ["This file has no history (it may not be part of the git repository)."]
+
+    filehistory = [ x.replace("<", "&lt;").replace(">", "&gt;") for x in filehistory]
+
+    filehistory = "<pre>\n" + "</pre><pre>\n".join(filehistory) + "</pre>"
+
+    return filehistory
+
+
+def get_dirs_to_index(folder):
     r = []
 
     for root, folders, files in os.walk(folder):
+        if pathlib.Path(os.path.join(root, folder)).is_relative_to(folder.joinpath('permalink')):
+            continue
         [r.append(os.path.join(root, folder)) for folder in folders]
 
     return r
 
 
+def update_required(src_filename, output_filename):
+    return not os.path.exists(output_filename) or os.path.getmtime(src_filename) > os.path.getmtime(output_filename)
+
+
 def get_args():
     """ Get command line arguments """
 
@@ -56,7 +146,17 @@ def get_args():
     parser.add_argument('-i', '--template-index-head', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/indexhead.html'))
     parser.add_argument('-I', '--template-index-foot', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/indexfoot.html'))
     parser.add_argument('-s', '--stylesheet', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/styles.css'))
+    parser.add_argument('--home_index', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/home_index.html'))
+    parser.add_argument('--permalink_index', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/permalink_index.html'))
     parser.add_argument('-e', '--extra-index-content', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/templates/extra_index_content.html'))
+    parser.add_argument('-n', '--index-article-names', action='append', default=['index.md'])
+    parser.add_argument('-F', '--force', action="store_true", help="Generate new output html even if source file was modified before output html")
+    parser.add_argument('--fuse', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/fuse.js'))
+    parser.add_argument('--searchjs', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/search.js'))
+    parser.add_argument('--indexsearchjs', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/indexsearch.js'))
+    parser.add_argument('--permalinkjs', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/permalink.js'))
+    parser.add_argument('--tocsearchjs', type=pathlib.Path, default=pathlib.Path('/opt/notes2web/toc_search.js'))
+    parser.add_argument('--toc-depth', type=int, default=6, dest='toc_depth')
     return parser.parse_args()
 
 
@@ -78,98 +178,245 @@ def main(args):
     with open(args.extra_index_content) as fp:
         EXTRA_INDEX_CONTENT = fp.read()
 
-    if not os.path.exists(args.output_dir):
-        os.makedirs(args.output_dir, exist_ok=True)
+    if args.output_dir.is_file():
+        print(f"Output directory ({args.output_dir}) cannot be a file.")
 
-    if os.path.isfile(args.output_dir):
-        print("Output directory ({output_dir}) cannot be a file.")
+    args.output_dir.mkdir(parents=True, exist_ok=True)
 
+    notes_license = "This note has no copyright license.",
+    print(f"{notes_license=}")
+    license_path = args.notes.joinpath("LICENSE")
+    if license_path.exists():
+        with open(license_path) as fp:
+            notes_license = fp.read()
 
     markdown_files, plaintext_files, other_files = get_files(args.notes)
 
+    all_entries=[]
+    dirs_with_index_article = []
+    tag_dict = {}
+    permalink_to_filepath = {}
+
     print(f"{markdown_files=}")
     for filename in markdown_files:
         print(f"{filename=}")
-        html = pypandoc.convert_file(filename, 'html', extra_args=[f'--template={args.template}'])
-        output_filename = os.path.splitext(re.sub(f"^{args.notes.name}", args.output_dir.name, filename))[0] + '.html'
-        os.makedirs(os.path.dirname(output_filename), exist_ok=True)
+
+        # calculate output filename
+        output_filename = args.output_dir.joinpath('notes').joinpath(
+            pathlib.Path(filename).relative_to(args.notes)
+        ).with_suffix('.html')
+        if os.path.basename(filename) in args.index_article_names:
+            output_filename = output_filename.parent.joinpath('index.html')
+            dirs_with_index_article.append(str(output_filename.parent))
+        print(f"{output_filename=}")
+
+        # extract tags from frontmatter, save to tag_dict
+        fm = frontmatter.load(filename)
+        if isinstance(fm.get('tags'), list):
+            for tag in list(set(fm.get('tags') + get_inherited_tags(filename, args.notes))):
+                t = {
+                    'path': str(pathlib.Path(output_filename).relative_to(args.output_dir)),
+                    'title': fm.get('title') or pathlib.Path(filename).name
+                }
+                if tag in tag_dict.keys():
+                    tag_dict[tag].append(t)
+                else:
+                    tag_dict[tag] = [t]
+
+        # find headers in markdown
+        with open(filename) as fp:
+            lines = fp.read().split('\n')
+        header_lines = []
+        for line in lines:
+            if re.match('^#{1,6} \S', line):
+                header_lines.append(" ".join(line.split(" ")[1:]))
+
+        all_entries.append({
+            'path': '/' + str(pathlib.Path(*pathlib.Path(output_filename).parts[1:])),
+            'title': fm.get('title') or pathlib.Path(filename).name,
+            'tags': list(set(fm.get('tags'))),
+            'headers': header_lines,
+            'uuid': fm.get('uuid')
+        })
+
+        if 'uuid' in fm.keys():
+            permalink_to_filepath[fm['uuid']] = all_entries[-1]['path']
+
+        # update file if required
+        if update_required(filename, output_filename) or args.force:
+            filehistory = git_filehistory(args.notes, filename)
+            with open(filename) as fp:
+                article = frontmatter.load(fp)
+
+            article['tags'] += get_inherited_tags(filename, args.notes)
+            article['tags'] = sorted(list(set(article['tags'])))
+            article['filehistory'] = filehistory
+            article['licenseFull'] = notes_license
+            html = pypandoc.convert_text(frontmatter.dumps(article), 'html', format='md', extra_args=[
+                f'--template={args.template}',
+                '--mathjax',
+                '--toc', f'--toc-depth={args.toc_depth}'
+            ])
+            pathlib.Path(output_filename).parent.mkdir(parents=True, exist_ok=True)
 
             with open(output_filename, 'w+') as fp:
                 fp.write(html)
 
     print(f"{plaintext_files=}")
     for filename in plaintext_files:
-        output_filename = re.sub(f"^{args.notes.name}", args.output_dir.name, filename) + '.html'
-        os.makedirs(os.path.dirname(output_filename), exist_ok=True)
-        title = os.path.basename(output_filename)
+        filehistory = git_filehistory(args.notes, filename)
+        title = os.path.basename(filename)
+        output_filename = str(
+            args.output_dir.joinpath('notes').joinpath(
+                pathlib.Path(filename).relative_to(args.notes)
+            )
+        ) + '.html'
+        print(f"{output_filename=}")
+
+        pathlib.Path(output_filename).parent.mkdir(parents=True, exist_ok=True)
         html = re.sub(r'\$title\$', title, TEXT_ARTICLE_TEMPLATE_HEAD)
+        html = re.sub(r'\$h1title\$', title, html)
         html = re.sub(r'\$raw\$', os.path.basename(filename), html)
+        html = re.sub(r'\$licenseFull\$', notes_license, html)
+        html = html.replace('$filehistory$', filehistory)
         with open(filename) as fp:
-            html += fp.read()
+            html += fp.read().replace("<", "&lt;").replace(">", "&gt;")
         html += TEXT_ARTICLE_TEMPLATE_FOOT
 
         with open(output_filename, 'w+') as fp:
             fp.write(html)
+        all_entries.append({
+            'path': str(pathlib.Path(*pathlib.Path(output_filename).parts[1:])),
+            'title': title,
+            'tags': [get_inherited_tags(filename, args.notes)],
+            'headers': []
+        })
 
     print(f"{other_files=}")
     for filename in other_files:
-        output_filename = re.sub(f"^{args.notes.name}", args.output_dir.name, filename)
-        os.makedirs(os.path.dirname(output_filename), exist_ok=True)
+        output_filename = str(
+            args.output_dir.joinpath('notes').joinpath(
+                pathlib.Path(filename).relative_to(args.notes)
+            )
+        )
+        title = os.path.basename(filename)
+        pathlib.Path(output_filename).parent.mkdir(parents=True, exist_ok=True)
+        all_entries.append({
+            'path': str(pathlib.Path(*pathlib.Path(output_filename).parts[1:])),
+            'title': title,
+            'tags': [get_inherited_tags(filename, args.notes)],
+            'headers': []
+        })
         shutil.copyfile(filename, output_filename)
 
+    tagdir = args.output_dir.joinpath('.tags')
+    tagdir.mkdir(parents=True, exist_ok=True)
 
-    dirs_to_index = [args.output_dir.name] + get_dirs(args.output_dir)
+    for tag in tag_dict.keys():
+        html = re.sub(r'\$title\$', f'{tag}', INDEX_TEMPLATE_HEAD)
+        html = re.sub(r'\$h1title\$', f'tag: {tag}', html)
+        html = re.sub(r'\$extra_content\$', '', html)
+
+        for entry in tag_dict[tag]:
+            entry['path'] = '/' + entry['path']
+            html += f"<div class=\"article\"><a href=\"{entry['path']}\">{entry['title']}</a></div>"
+        html += re.sub('\$data\$', json.dumps(tag_dict[tag]), INDEX_TEMPLATE_FOOT)
+
+        with open(tagdir.joinpath(f'{tag}.html'), 'w+') as fp:
+            fp.write(html)
+
+    dirs_to_index = [args.output_dir.name] + get_dirs_to_index(args.output_dir)
     print(f"{dirs_to_index=}")
-    print(f"{os.path.commonpath(dirs_to_index)=}")
+    print(f"{dirs_with_index_article=}")
 
-    for directory in dirs_to_index:
+    for d in dirs_to_index:
+        print(f"{d in dirs_with_index_article=} {d=}")
+        if d in dirs_with_index_article:
+            continue
+
+        directory = pathlib.Path(d)
         paths = os.listdir(directory)
-        print(f"{paths=}")
+        #print(f"{paths=}")
 
         indexentries = []
         
-        for path in paths:
-            if path == 'index.html':
+        for p in paths:
+            path = pathlib.Path(p)
+            #print(f"{path=}")
+            if p in [ 'index.html', '.git' ]:
                 continue
 
-            fullpath = os.path.join(directory, path)
-            if os.path.splitext(path)[1] == '.html':
+            fullpath = directory.joinpath(path)
+            title = path.name
+            if path.suffix == '.html':
                 with open(fullpath) as fp:
                     soup = bs(fp.read(), 'html.parser')
 
                 try:
-                    title = soup.find('title').get_text()
+                    title = soup.find('title').get_text() or pathlib.Path(path).name
                 except AttributeError:
+                    title = pathlib.Path(path).stem
+            elif fullpath.is_dir():
                 title = path
-            else:
-                title = path
+            elif is_plaintext(fullpath):
+                # don't add plaintext files to index, since they have a html wrapper
+                continue
 
-            if title.strip() == '':
+            if str(title).strip() == '':
                 title = path
 
             indexentries.append({
-                'title': title,
-                'path': path,
-                'isdirectory': os.path.isdir(fullpath)
+                'title': str(title),
+                'path': './' + str(path),
+                'isdirectory': fullpath.is_dir()
                 })
 
-        indexentries.sort(key=lambda entry: entry['title'])
+        indexentries.sort(key=lambda entry: str(entry['title']).lower())
         indexentries.sort(key=lambda entry: entry['isdirectory'], reverse=True)
         
-        html = re.sub(r'\$title\$', directory, INDEX_TEMPLATE_HEAD)
+        html = re.sub(r'\$title\$', str(directory), INDEX_TEMPLATE_HEAD)
+        html = re.sub(r'\$h1title\$', str(directory), html)
         html = re.sub(r'\$extra_content\$',
-                EXTRA_INDEX_CONTENT if directory == os.path.commonpath(dirs_to_index) else '',
+                EXTRA_INDEX_CONTENT if directory == args.notes else '',
                 html
                 )
 
         for entry in indexentries:
-            html += f"<div class=\"article\"><a href=\"{entry['path']}\">{entry['title']}{'/' if entry['isdirectory'] else ''}</a></div>"
-        html += INDEX_TEMPLATE_FOOT
+            html += (
+                    '<li class="article">'
+                        f'<a href="{entry["path"]}"><p>'
+                            f'{entry["title"]}{"/" if entry["isdirectory"] else ""}'
+                        '</p></a>'
+                    '</li>'
+            )
+        html += re.sub(r'\$data\$', json.dumps(indexentries), INDEX_TEMPLATE_FOOT)
 
-        with open(os.path.join(directory, 'index.html'), 'w+') as fp:
+        with open(directory.joinpath('index.html'), 'w+') as fp:
             fp.write(html)
 
-    shutil.copyfile(args.stylesheet, os.path.join(args.output_dir.name, 'styles.css'))
+    shutil.copyfile(args.stylesheet, args.output_dir.joinpath('styles.css'))
+    shutil.copyfile(args.fuse, args.output_dir.joinpath('fuse.js'))
+    shutil.copyfile(args.searchjs, args.output_dir.joinpath('search.js'))
+    shutil.copyfile(args.indexsearchjs, args.output_dir.joinpath('indexsearch.js'))
+    shutil.copyfile(args.tocsearchjs, args.output_dir.joinpath('toc_search.js'))
+    shutil.copyfile(args.permalinkjs, args.output_dir.joinpath('permalink.js'))
+    with open(args.output_dir.joinpath('index.html'), 'w+') as fp:
+        with open(args.home_index) as fp2:
+            html = re.sub(r'\$title\$', args.output_dir.parts[0], fp2.read())
+            html = re.sub(r'\$h1title\$', args.output_dir.parts[0], html)
+            html = re.sub(r'\$n2w_commit\$', N2W_COMMIT, html)
+            html = re.sub(r'\$notes_git_head_sha1\$', git_head_sha1(args.notes), html)
+
+        html = re.sub(r'\$data\$', json.dumps(all_entries), html)
+
+        fp.write(html)
+    permalink_dir = args.output_dir.joinpath('permalink')
+    permalink_dir.mkdir(exist_ok=True)
+    with open(args.permalink_index) as fp:
+        html = re.sub(r'\$data\$', json.dumps(permalink_to_filepath), fp.read())
+    with open(permalink_dir.joinpath('index.html'), 'w+') as fp:
+        fp.write(html)
+    print(tag_dict)
 
     return 0
 

permalink.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const MANUAL_REDIRECT = document.getElementById('manual_redirect');
+
+const newLocation = data[new URLSearchParams(window.location.search).get('uuid')];
+
+MANUAL_REDIRECT.href = newLocation;
+window.location = newLocation;

readme.md

@@ -1,24 +1,84 @@
+> notes2web is now called [gronk](https://github.com/alvierahman90/gronk) and development has moved
+
 # notes2web
 
-View your notes as a static html site.
+View your notes as a static html site. Browse a live sample of it [here](https://notes.alv.cx).
 
 ![](./screenshot.png)
 
+Tested with [pandoc v2.19.2](https://github.com/jgm/pandoc/releases/tag/2.19.2).
+
+
+## Why?
+
+I want to be able to view my notes in a more convenient way.
+I was already writing them in Pandoc markdown and could view them as PDFs but that wasn't quite
+doing it for me:
+
+- It was inconvenient to flick through multiple files of notes to find the right PDF
+- It was annoying to sync to my phone
+- PDFs do not scale so they were hard to read on smaller screens
+- Probably more reasons I can't think of right now
+- Fun
+
+
 ## Install
 
-0. Install [Pandoc](https://pandoc.org/index.html) and [yq](https://github.com/mikefarah/yq)
-
-   On arch:
-   ```
-   # pacman -S pandoc yq
-   ```
-
+0. Install [Pandoc](https://pandoc.org/index.html) and [Pip](https://github.com/pypa/pip), python3-dev, and a C compiler
 1. Run `make install` as root
 
-## Usage
+## Things to Remember Whilst Writing Notes
+
+- notes2web reads the following YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) variable:
+
+  - `author` --- The person(s) who wrote the article
+  - `tags` --- A YAML list of tags which the article relates to - this is used for browsing and also
+               searching
+  - `title` --- The title of the article
+  - `uuid` --- A unique identifier used for permalinks. More below.
+  - `lecture_slides` --- a list of paths pointing to lecture slides used while taking notes
+  - `lecture_notes` --- a list of paths pointing to other notes used while taking notes
+        
+- notes2web indexes [ATX-style headings](https://pandoc.org/MANUAL.html#atx-style-headings) for
+  searching
+- notes2web attempts to display file history through the `git log` command
+- notes2web looks for the plaintext file `LICENSE` in the root directory of your notes
+
+  This is optional but if you would like to add a license you can find one
+  [here](https://choosealicense.com).
+
+### Permalinks
+
+Permalinks are currently rather basic and requires JavaScript to be enabled on the local computer.
+In order to identify documents between file changes, a unique identifier is used to identify a file.
+
+This unique identifier can be generated using the `uuidgen` command in the `uuid-runtime` package or
+`str(uuid.uuid())` in the `uuid` python package.
+
+The included `n2w_add_uuid.py` will add a UUID to a markdown file which does not have a UUID in it
+already.
+Combine it with `find` to UUIDify all your markdown files (but make a backup first).
+
+### Inherited Properties
+
+Notes can inherit a some properties from their parent folder(s) by creating a `.n2w.yml` file in a
+folder.
+
+#### Tags
+
+If you have a folder `uni` with all you university notes, you might want all the files in there to
+be tagged `uni`:
+
+`NOTES_PATH/uni/.n2w.yaml`:
+
+```yaml
+itags: [ university ]
+```
+
+## CLI Usage
 
 ```
-$ notes2web.py NOTES_DIRECTORY_1
+$ notes2web.py notes_directory
 ```
 
 Output of `notes2web.py --help`:
@@ -27,7 +87,9 @@ Output of `notes2web.py --help`:
 usage: notes2web.py [-h] [-o OUTPUT_DIR] [-t TEMPLATE] [-H TEMPLATE_TEXT_HEAD]
                     [-f TEMPLATE_TEXT_FOOT] [-i TEMPLATE_INDEX_HEAD]
                     [-I TEMPLATE_INDEX_FOOT] [-s STYLESHEET]
-                    [-e EXTRA_INDEX_CONTENT]
+                    [--home_index HOME_INDEX] [-e EXTRA_INDEX_CONTENT]
+                    [-n INDEX_ARTICLE_NAMES] [-F] [--fuse FUSE]
+                    [--searchjs SEARCHJS]
                     notes
 
 positional arguments:
@@ -42,7 +104,13 @@ optional arguments:
   -i TEMPLATE_INDEX_HEAD, --template-index-head TEMPLATE_INDEX_HEAD
   -I TEMPLATE_INDEX_FOOT, --template-index-foot TEMPLATE_INDEX_FOOT
   -s STYLESHEET, --stylesheet STYLESHEET
+  --home_index HOME_INDEX
   -e EXTRA_INDEX_CONTENT, --extra-index-content EXTRA_INDEX_CONTENT
+  -n INDEX_ARTICLE_NAMES, --index-article-names INDEX_ARTICLE_NAMES
+  -F, --force           Generate new output html even if source file was
+                        modified before output html
+  --fuse FUSE
+  --searchjs SEARCHJS
 ```
 
 The command will generate a website in the `output-dir` directory (`./web` by default).
@@ -55,3 +123,11 @@ Then you just have to point a webserver at `output-dir`.
 ```
 # make uninstall
 ```
+
+## Acknowledgements
+
+Default synatx highlighting is based off [Pygments](https://pygments.org/)' default theme and
+made using Pandoc v2.7.2.
+I found the theme [here](https://github.com/tajmone/pandoc-goodies/blob/master/skylighting/css/built-in-styles/pygments.css).
+
+Pretty sure the link colours are taken from [thebestmotherfucking.website](https://thebestmotherfucking.website/).

requirements.txt

@@ -1,3 +1,11 @@
 beautifulsoup4==4.9.3
+editfrontmatter==0.0.1
+Jinja2==3.0.3
+MarkupSafe==2.1.0
+oyaml==1.0
 pypandoc==1.5
+python-frontmatter==1.0.0
+python-magic==0.4.24
+PyYAML==5.3.1
+regex==2021.11.10
 soupsieve==2.2.1

search.js

@@ -0,0 +1,125 @@
+const HEADERS = "headers"
+const PATH = "path"
+const TAGS = "tags"
+const TITLE = "title"
+
+const SEARCH_TIMEOUT_MS = 100
+var SEARCH_TIMEOUT_ID = -1
+
+const fuse = new Fuse(data, {
+  keys: [
+    {
+      name: HEADERS,
+      weight: 0.2
+    },
+    {
+      name: PATH,
+      weight: 0.1
+    },
+    {
+      name: TAGS,
+      weight: 0.1
+    },
+    {
+      name: TITLE,
+      weight: 4
+    }
+  ],
+  includeMatches: true,
+  useExtendedSearch: true,
+  ignoreLocation: true,
+  threshhold: 0.4,
+})
+
+const RESULTS_MAX = 5
+
+const searchBar = document.getElementById('search')
+const resultsDiv = document.getElementById('results')
+
+var results = []
+
+function updateResultsWithTimeout() {
+  console.log("clearing timeout")
+  if (SEARCH_TIMEOUT_ID) SEARCH_TIMEOUT_ID = clearTimeout(SEARCH_TIMEOUT_ID)
+  SEARCH_TIMEOUT_ID = setTimeout(updateResults, SEARCH_TIMEOUT_MS)
+}
+
+function updateResults() {
+  console.log("updating results")
+  resultsDiv.innerHTML = ''
+  results = fuse.search(searchBar.value, { limit: RESULTS_MAX })
+  results.forEach(r => {
+    wrapper = document.createElement('div')
+    wrapper.className = "article"
+
+    display_matches = {}
+    display_matches[HEADERS] = []
+    display_matches[PATH] = []
+    display_matches[TAGS] = []
+    display_matches[TITLE] = []
+
+    r.matches.every(match => {
+      if (display_matches[match.key].length > 3) {
+        display_matches[match.key].push('...')
+        return false
+      }
+
+      display_match = match.value
+      if (match.indices.length >= 1) {
+        match.indices.sort((a, b) => (b[1]-b[0])-(a[1]-a[0]))
+        indexPair = match.indices[0]
+        matching_slice = match.value.slice(indexPair[0], indexPair[1]+1)
+        display_match = match.value.replace(
+          matching_slice,
+          '<span class="matchHighlight">' + matching_slice + '</span>'
+        )
+      }
+      display_matches[match.key].push(display_match)
+
+      return true
+    })
+
+    content = document.createElement('a')
+    content.innerHTML = r.item.title
+    content.href = r.item.path
+
+    wrapper.appendChild(content)
+
+    Object.keys(display_matches).forEach(key => {
+      if (display_matches[key].length < 1) return
+
+      p = document.createElement('p')
+      p.className = "smallText"
+      p.innerHTML += key + ": [" + display_matches[key].join(', ') + ']'
+      wrapper.appendChild(p)
+    })
+
+    resultsDiv.appendChild(wrapper)
+  })
+}
+
+searchBar.addEventListener('keyup', e => {
+  console.log(e)
+  // if user pressed enter
+  if (e.keyCode === 13) {
+    if (e.shiftKey) {
+      window.open(results[0].item.path, '_blank')
+    } else {
+    window.location.href = results[0].item.path
+    }
+    return
+  }
+  updateResultsWithTimeout()
+})
+
+searchBar.addEventListener('change', updateResultsWithTimeout)
+
+const searchParams = new URL(window.location.href).searchParams;
+searchBar.value = searchParams.get('q');
+updateResults();
+
+console.log(results)
+
+if (searchParams.has('lucky')) {
+  window.location.href = results[0].item.path;
+}

styles.css

@@ -1,73 +1,185 @@
+@import url("https://styles.alv.cx/colors/gruvbox.css");
+@import url("https://styles.alv.cx/base.css");
+@import url("https://styles.alv.cx/modules/search.css");
+@import url("https://styles.alv.cx/modules/buttonlist.css");
+@import url("https://styles.alv.cx/modules/darkmode.css");
+
+html {
+  scroll-behavior: smooth;
+}
+
+h1 { font-size: 2.5em }
+h2 { font-size: 2em;}
+h3 { font-size: 1.5em; }
+
 body {
-	font-family: "Open Sans", sans-serif;
-	color: #454545;
-	font-size: 16px;
-	margin: 2em auto;
-	max-width: 800px;
-	padding: 1em;
-	line-height: 1.4;
-	text-align: justify;
-	background-color: #fefefe;
-	overflow-wrap: break-word;
-}
-
-a { color: #07a; }
-a:visited { color: #941352; }
-
-img[class="centered"] {
-	margin: 0 auto;
-	display: block;
-}
-
-table {
-	border-collapse: collapse;
-	margin: 1em auto;
-	max-width: 100%;
-}
-th, td {
-	padding: 1em;
-	border: 1px solid #454545;
-	margin: 0;
-}
-
-
-pre {
-	background-color: #d9d9d9 ;
-	color: #000;
-	padding: 1em;
-}
-
-details {
-	padding: 1em 0 1em 0;
-}
-
-li {
-	margin-bottom: 1em;
-}
-
-img {
-	margin: 0 auto;
-	display: block;
-	max-width: 100%;
-}
-
-figcaption {
-	margin: 0 auto;
-	width: max-content;
+	max-width: none;
+	width: 100%;
+	box-sizing: border-box;
 }
 
 .article {
 	margin: 1em;
 }
 
-blockquote {
-	border-left: 0.4em solid #454545;
-	margin-left: 0;
-	padding-left: 1em;
-	padding-top: 0.5em;
-	padding-bottom: 0.5em;
+.smallText {
+	font-size: 0.7em;
 }
 
-blockquote * {
-	margin: 0;
+.article .smallText {
+	margin: 0
 }
+
+.matchHighlight {
+	background-color: var(--blue);
+}
+
+#sidebar > #header { padding-bottom: 1em; color: var(--fg-lc);}
+
+#header > * {
+	margin: 0;
+	padding: 0;
+}
+
+#contentWrapper {
+	display: flex
+}
+
+
+#sidebar {
+	position: sticky;
+	top: 10vh;
+	height: 80vh;
+	max-width: 30em;
+	display: flex;
+	flex-direction: column;
+	min-width: 20em;
+	padding-right: 1em;
+}
+
+#content {
+	margin: 0 auto;
+	width: 60em;
+	max-width: 100%;
+}
+
+#commitlog, #license { padding: 0; }
+
+#toc {
+	overflow-y: scroll;
+	overflow-x: visible;
+	max-width: 100%;
+}
+
+#sidebar,
+#toc li > a { 
+	color: var(--fg-lc);
+}
+
+#toc li, ul#articlelist { list-style: none; }
+#toc ul, ul#articlelist { margin-left: 0.75em ; padding-left: 0.75em; }
+#toc ul, ul#articlelist { border-left: 1px solid var(--fg-lc);}
+#toc > ul { padding; none; padding: 0; margin: 0; border: none;max-width: 100%;}
+li { padding: 0 !important; }
+
+#toc li > a,
+ul#articlelist > a{
+	text-decoration: none;
+	display: inline-block;
+	width: 100%;
+	transition: 0.5s;
+	padding: 0.5em;
+	box-sizing: border-box;
+}
+#toc li > a:hover,
+ul#articlelist li a:hover {
+	background: var(--bg-lc);
+	color: black;
+}
+
+mjx-container {
+	overflow-x: auto;
+}
+
+p.metadata { margin: 0 }
+
+@media (max-width: 80em) {
+  /* CSS that should be displayed if width is equal to or less than 60em goes here */
+	#contentWrapper { flex-direction: column }
+	#sidebar { position: static; width: 100%; max-width: none; height: auto; }
+	#tocWrapper { display: none }
+}
+
+
+/*  ==============================================================================
+                         Pygments (pandoc built-in style)
+    ==============================================================================
+    Style based on Pygments' default colors.
+
+    This stylesheet was produced using Pandoc v2.7.2.
+
+    Pandoc is (c) 2006-2017 John MacFarlane (jgm@berkeley.edu).
+    Released under the GPL, version 2 or greater.
+    ------------------------------------------------------------------------------
+*/
+a.sourceLine { display: inline-block; line-height: 1.25; }
+a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }
+a.sourceLine:empty { height: 1.2em; }
+.sourceCode { overflow: visible; }
+code.sourceCode { white-space: pre; position: relative; }
+div.sourceCode { margin: 1em 0; }
+pre.sourceCode { margin: 0; }
+@media screen {
+div.sourceCode { overflow: auto; }
+}
+@media print {
+code.sourceCode { white-space: pre-wrap; }
+a.sourceLine { text-indent: -1em; padding-left: 1em; }
+}
+pre.numberSource a.sourceLine
+  { position: relative; left: -4em; }
+pre.numberSource a.sourceLine::before
+  { content: attr(title);
+    position: relative; left: -1em; text-align: right; vertical-align: baseline;
+    border: none; pointer-events: all; display: inline-block;
+    -webkit-touch-callout: none; -webkit-user-select: none;
+    -khtml-user-select: none; -moz-user-select: none;
+    -ms-user-select: none; user-select: none;
+    padding: 0 4px; width: 4em;
+    color: #aaaaaa;
+  }
+pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa;  padding-left: 4px; }
+div.sourceCode
+  {  }
+@media screen {
+a.sourceLine::before { text-decoration: underline; }
+}
+code span.al { color: #ff0000; font-weight: bold; } /* Alert */
+code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
+code span.at { color: #7d9029; } /* Attribute */
+code span.bn { color: #40a070; } /* BaseN */
+code span.bu { } /* BuiltIn */
+code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
+code span.ch { color: #4070a0; } /* Char */
+code span.cn { color: #880000; } /* Constant */
+code span.co { color: #60a0b0; font-style: italic; } /* Comment */
+code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
+code span.do { color: #ba2121; font-style: italic; } /* Documentation */
+code span.dt { color: #902000; } /* DataType */
+code span.dv { color: #40a070; } /* DecVal */
+code span.er { color: #ff0000; font-weight: bold; } /* Error */
+code span.ex { } /* Extension */
+code span.fl { color: #40a070; } /* Float */
+code span.fu { color: #06287e; } /* Function */
+code span.im { } /* Import */
+code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
+code span.kw { color: #007020; font-weight: bold; } /* Keyword */
+code span.op { color: #666666; } /* Operator */
+code span.ot { color: #007020; } /* Other */
+code span.pp { color: #bc7a00; } /* Preprocessor */
+code span.sc { color: #4070a0; } /* SpecialChar */
+code span.ss { color: #bb6688; } /* SpecialString */
+code span.st { color: #4070a0; } /* String */
+code span.va { color: #19177c; } /* Variable */
+code span.vs { color: #4070a0; } /* VerbatimString */
+code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */

templates/article.html

@@ -1,14 +1,74 @@
 <head>
-<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
 <meta charset="utf-8"> 
 <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans&display=swap" />
 <link rel="stylesheet" type="text/css" href="/styles.css" />
 <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
+<script>
+	MathJax = {
+		tex: {
+			tags: 'ams'
+		}
+	}
+</script>
 <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
 <title>$title$</title>
 </head>
 
 <body>
+	<div id="contentWrapper">
+		<div id="content">
+		<p class="smallText metadata">
+			title: $title$
+		</p>
+		$if(lecture_slides)$
+		<p class="smallText metadata"> lecture_slides: [
+			$for(lecture_slides)$
+			<a href="$lecture_slides$">$lecture_slides$</a>$sep$,
+			$endfor$
+		]</p>
+		$endif$
+		$if(lecture_notes)$
+		<p class="smallText metadata"> lecture_notes: [
+			$for(lecture_notes)$
+			<a href="$lecture_notes$">$lecture_notes$</a>$sep$,
+			$endfor$
+		]</p>
+		$endif$
+
+		<p class="smallText metadata">
+			uuid: $uuid$ (<a href="/permalink?uuid=$uuid$">permalink</a>)
+		</p>
+		<p class="smallText metadata"> tags: [
+			$for(tags)$
+			<a href="/.tags/$tags$.html">$tags$</a>$sep$,
+			$endfor$
+		]</p>
+		<p class="smallText metadata">
+			written by $for(author)$$author$$sep$, $endfor$
+		</p>
+		<p class="smallText metadata">
+			syntax highlighting based on <a href="https://pygments.org/">Pygments'</a> default
+			colors
+		</p>
+		<p class="smallText metadata">
+			page generated by <a href="https://git.alv.cx/alvierahman90/notes2web">notes2web</a>
+		</p>
+		<details id="commitLog">
+			<summary class="smallText">
+				Commit log (file history)
+			</summary>
+			$filehistory$
+		</details>
+		<details id="license">
+			<summary class="smallText">
+				License
+			</summary>
+			<pre>$licenseFull$</pre>
+		</details>
 		$body$
-	<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
+		</div>
+	</div>
+	<script src="/fuse.js"> </script>
+	<script src="/toc_search.js"> </script>
 </body>

templates/extra_index_content.html

@@ -1 +1,4 @@
-<p>These are my personal notes. Correctness is not guaranteed.</p>
+<p>
+These are my personal notes. Correctness is not guaranteed.
+Browse by tag <a href="/.tags">here</a>.
+</p>

templates/home_index.html

@@ -0,0 +1,28 @@
+<head>
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
+<meta charset="utf-8"> 
+<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans&display=swap" />
+<link rel="stylesheet" type="text/css" href="/styles.css" />
+<title>$title$</title>
+</head>
+<body>
+<div id="content">
+	<h1>$h1title$</h1>
+<p>
+These are my personal notes. Correctness is not guaranteed.
+Browse <a href="/notes">here</a> or by tag <a href="/.tags">here</a>.
+</p>
+
+<div id="searchWrapper">
+<input autocomplete="off" placeholder="search" id="search" autofocus>
+</div>
+<p class="smallText" style="margin-top: 0; text-align: center;"> Press <kbd>Enter</kbd> to open first result or <kbd>Shift</kbd>+<kbd>Enter</kbd> to open in new tab</p>
+<div id="results">
+</div>
+
+<p class="smallText"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a> (commit $n2w_commit$) notes commit $notes_git_head_sha1$</p>
+</div>
+<script src="/fuse.js"> </script>
+<script> const data = $data$ </script>
+<script src="/search.js"> </script>
+</body>

templates/index.html

@@ -1,13 +1,14 @@
 <head>
-<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
 <meta charset="utf-8"> 
 <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans&display=swap" />
 <link rel="stylesheet" type="text/css" href="/styles.css" />
 <title>$title$</title>
 </head>
 <body>
-	<h1>$title$</h1>
+	<h1>$h1title$</h1>
+	<div id="content">
 $body$
-
-<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
+	<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
+	</div>
 </body>

templates/indexfoot.html

@@ -1,2 +1,7 @@
+	</ul>
 	<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
+	</div>
+	<script src="/fuse.js"> </script>
+	<script> const data = $data$ </script>
+	<script src="/indexsearch.js"> </script>
 </body>

templates/indexhead.html

@@ -1,5 +1,5 @@
 <head>
-<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
 <meta charset="utf-8"> 
 <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans&display=swap" />
 <link rel="stylesheet" type="text/css" href="/styles.css" />
@@ -7,6 +7,15 @@
 </head>
 
 <body>
+	<div id="content">
 	<h1>$title$</h1>
 	$extra_content$
-	<div class="article"><a href="..">../</a></div>
+	<div id="searchWrapper">
+	<input id="search" placeholder="search" autocomplete="off" autofocus>
+	</div>
+	<p class="searchSmallText" style="margin-top: 0; text-align: center">
+		Press (<kbd>Shift</kbd>+)<kbd>Enter</kbd> to open first result (in new tab)
+	</p>
+
+	<ul id="searchResults" class="buttonlist">
+		<li class="article"><a href=".."><p>../</p></a></li>

templates/listitem.html

@@ -1,7 +0,0 @@
-<li>
-	<a href="$filepath$"> $if(title)$
-$title$
-$else$
-no title ($filepath$)
-$endif$</a>
-</li>

templates/n2w_add_uuid_frontmatter_template

@@ -0,0 +1,5 @@
+author: {{ author }}
+date: {{ date }}
+title: {{ title }}
+tags: {{ tags }}
+uuid: {{ uuid }}

templates/permalink_index.html

@@ -0,0 +1,19 @@
+<head>
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
+<meta charset="utf-8"> 
+<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans&display=swap" />
+<link rel="stylesheet" type="text/css" href="/styles.css" />
+<title></title>
+</head>
+<body>
+<div id="content">
+<p>
+You should be being redirected...
+Otherwise, click <a id="manual_redirect">here</a>.
+</p>
+
+<p class="smallText"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
+</div>
+<script> const data = $data$ </script>
+<script src="/permalink.js"> </script>
+</body>

templates/textarticlefoot.html

@@ -1,3 +1,3 @@
 	</pre>
-	<p style="font-size: 0.7em;"> page generated by <a href="https://github.com/alvierahman90/notes2web">notes2web</a></p>
+	</div>
 </body>

templates/textarticlehead.html

@@ -1,5 +1,5 @@
 <head>
-<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
 <meta charset="utf-8"> 
 <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans&display=swap" />
 <link rel="stylesheet" type="text/css" href="/styles.css" />
@@ -7,6 +7,24 @@
 </head>
 
 <body>
+	<div id="content">
+	<div id="header">
+	<p class="smallText">
+		page generated by <a href="https://git.alv.cx/alvierahman90/notes2web">notes2web</a>
+	</p>
+	<details>
+		<summary class="smallText">
+			Commit log (file history)
+		</summary>
+		$filehistory$
+	</details>
+	<details>
+		<summary class="smallText">
+			License
+		</summary>
+		<pre>$licenseFull$</pre>
+	</details>
+	</div>
 	<h1>$title$</h1>
 	<p> This file was not rendered by notes2web because it is a plaintext file, not a markdown
 	file.

toc_search.js

@@ -0,0 +1,94 @@
+'use strict';
+
+var raw_html_tree = document.getElementById('toc').firstChild.cloneNode(true);
+
+function createSearchable(el) {
+  var par = el.parentElement;
+  var obj = el.cloneNode(true);
+
+  while(par != raw_html_tree) {
+    var clone_parent = par.cloneNode(true);
+
+    while (clone_parent.firstChild != clone_parent.lastChild) {
+      clone_parent.removeChild(clone_parent.lastChild);
+    }
+    console.log("obj.innerHTML: " + obj.innerHTML);
+    console.log("clone_parent.firstChild.innerHTML: " + clone_parent.firstChild.innerHTML);
+    if (obj.innerHTML != clone_parent.firstChild.innerHTML) 
+      clone_parent.appendChild(obj);
+
+    obj = clone_parent;
+    par = par.parentElement;
+  }
+
+  return {
+    searchable: el.innerHTML,
+    obj: obj
+  };
+}
+
+var searchables = [];
+Array(...raw_html_tree.getElementsByTagName('a'))
+  .forEach(el => searchables.push(createSearchable(el)));
+
+var fuse = new Fuse(searchables, { keys: [ 'searchable' ], includeMatches: true});
+var searchBar = document.getElementById('search');
+var resultsDiv = document.getElementById('toc');
+
+function updateResults() {
+  var ul = document.createElement('ul');
+  resultsDiv.innerHTML = '';
+  if (searchBar.value == '') {
+    resultsDiv.appendChild(raw_html_tree);
+    return;
+  }
+  var results = fuse.search(searchBar.value);
+
+
+  results.forEach(r => {
+    console.log(r)
+    var content = r.item.obj
+    var last_a = Array.from(r.item.obj.getElementsByTagName('a')).pop()
+
+    r.matches.reverse().every(match => {
+      var display_match = match.value;
+      if (match.indices.length >= 1) {
+        match.indices.sort((a, b) => (b[1]-b[0])-(a[1]-a[0]));
+        const indexPair = match.indices[0];
+        const matching_slice = match.value.slice(indexPair[0], indexPair[1]+1);
+        last_a.innerHTML = match.value.replace(
+          matching_slice,
+          '<span class="matchHighlight">' + matching_slice + '</span>'
+        );
+      }
+      return true;
+    })
+
+    ul.appendChild(content);
+    ul.appendChild(document.createElement('br'));
+  })
+  resultsDiv.appendChild(ul);
+}
+
+searchBar.addEventListener('keyup', e => {
+  // if user pressed enter
+  if (e.keyCode === 13) {
+    if (e.shiftKey) {
+      window.open(results[0].item.path, '_blank');
+    } else {
+    window.location.href = results[0].item.path;
+    }
+    return;
+  }
+  updateResults();
+})
+
+searchBar.addEventListener('change', updateResults);
+
+const searchParams = new URL(window.location.href).searchParams;
+searchBar.value = searchParams.get('q');
+updateResults();
+
+if (searchParams.has('lucky')) {
+  window.location.href = results[0].item.path;
+}