ci: Actually build release artifact

Automate the building of the Linux artifact and creation of a release on
new tags

.gitea/workflows/build.yaml

@@ -0,0 +1,13 @@
+name: Run Build
+run-name: ${{ gitea.actor }} building code
+on: push
+
+jobs:
+  dotnet:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-dotnet@v5
+        with:
+          dotnet-version: 10.x
+      - run: dotnet build csSiteGen.csproj

.gitea/workflows/publish.yaml

@@ -0,0 +1,39 @@
+name: Build and Generate Release Artifact
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 10.x
+
+      - name: Build csSiteGen
+        run: |
+          dotnet publish csSiteGen.csproj \
+          -c Release \
+          -r linux-x64 \
+          --self-contained true \
+          /p:PublishSingleFile=true \
+          /p:PublishTrimmed=true \
+          -o ./publish
+
+      - name: Create Gitea Release
+        id: create_release
+        uses: akkuman/gitea-release-action@v1
+        env:
+          NODE_OPTIONS: '--experimental-fetch'
+        with:
+          files: |-
+            ./publish/csSiteGen
+          body_path: ./meta/releaseNotes

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>.

Program.cs

@@ -16,15 +16,13 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-using Serilog.Events;
 using Serilog;
-using System.CommandLine.Builder;
-using System.CommandLine.Help;
-using System.CommandLine.Parsing;
 using System.CommandLine;
 using System.Diagnostics;
 using System.Reflection;
 using Spectre.Console;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace csSiteGen;
 
@@ -34,10 +32,12 @@ class Program
 	static int Main(string[] args)
 	{
 
-		// Get the current versiion number
+		// Get the current version number
 		string? version = Assembly.GetEntryAssembly()?.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion;
 
-		// Configure logger
+		// Only log to file
+		// Logging to the console is BAD practice as it tends to be messy.
+		// TODO: Log to a known location using environment to find the correct location.
 		Log.Logger = new LoggerConfiguration()
 			.MinimumLevel.Debug()
 			.WriteTo.File("log.log")
@@ -55,6 +55,7 @@ class Program
 		}
 
 		// It is very likely that this program will only work on linux. As such it is worth warning the user about this.
+		// With further testing and handling of any edge cases it _may_ be possible to have this work anywhere.
 		if (!OperatingSystem.IsLinux())
 		{
 			Log.Warning("This program has only been tested on linux and cannot be assumed to work on other Operating Systems");
@@ -63,78 +64,91 @@ class Program
 
 		Stopwatch TotalExecutionTime = Stopwatch.StartNew();
 
-		var inputDirectoryOption = new Option<DirectoryInfo>(
+		/* WARN:
-			name: "--input",
+			This code uses system.commandline
-			description: "The directory that contains the site source.");
+			the following section of code will contain comments to explain the intent of the programmer
-		inputDirectoryOption.IsRequired = true;
+			which may be useful if system.commandline has breaking changes
-		inputDirectoryOption.AddValidator(result =>
+		*/
+
+
+		// First the option for the project directory is created
+		Option<DirectoryInfo> ProjectDirectoryOption = new("--project","-p")
 		{
-					if (!result.GetValueForOption(inputDirectoryOption)!.Exists)
+			Description = "The directory of the project",
+			Required = false,
+			DefaultValueFactory = _ =>
 			{
-						result.ErrorMessage = $"Input directory {result.GetValueForOption(inputDirectoryOption)!.FullName} does not exist";
+				return new DirectoryInfo(Directory.GetCurrentDirectory());
+			}
+		};
+
+		// Add a validator as we want the directory to exist.
+		ProjectDirectoryOption.Validators.Add(result =>
+				{
+					if (! result.GetValue(ProjectDirectoryOption)!.Exists)
+					{
+					    result.AddError($"Directory {result.GetValue(ProjectDirectoryOption)} does not exist");
+						Log.Fatal($"Passed directory '{result.GetValue(ProjectDirectoryOption)}' does not exist");
 					}
 				});
 
-		var outputDirectoryOption = new Option<DirectoryInfo>(
+		// The root command is the entry point for commandline but otherwise does nothing.
-			name: "--output",
+		RootCommand rootCommand = new("csSiteGen");
-			description: "The directory that the site should be output to.");
-		outputDirectoryOption.IsRequired = true;
 
-		var rootCommand = new RootCommand("csSiteGen");
+		// This creates the command for cleaning a projects output directory.
-
+		var cleanCommand = new Command("clean", "Clean the projects output directory");
-		var cleanCommand = new Command("clean", "Clean the output directory");
+		cleanCommand.Options.Add(ProjectDirectoryOption); // This command can use the project directory option we created earlier
-		cleanCommand.AddOption(outputDirectoryOption);
+		cleanCommand.SetAction(parseResult =>
-		cleanCommand.SetHandler(async (directory) =>
 				{
-					await Task.Run(() =>
+							Clean(parseResult.GetValue<DirectoryInfo>("--project")!);
-						{
-							Clean(directory);
 				});
-				} ,outputDirectoryOption);
 
-		var convertCommand = new Command("convert", "Convert the input directory and place the files in the output directory.");
+		// This creates the command for actually converting the project.
-		convertCommand.AddOption(inputDirectoryOption);
+		var convertCommand = new Command("convert", "Convert the projects input directory and place the files in the output directory.");
-		convertCommand.AddOption(outputDirectoryOption);
+		convertCommand.Options.Add(ProjectDirectoryOption); // This command can use the project directory option
-		convertCommand.SetHandler(async (inputDir, outputDir) =>
+		convertCommand.SetAction(parseResult =>
 				{
-					await Task.Run(() =>
+						Convert(parseResult.GetValue<DirectoryInfo>("--project")!);
-					{
-						Convert(inputDir, outputDir);
 				});
-				}, inputDirectoryOption, outputDirectoryOption);
 
-		rootCommand.AddCommand(cleanCommand);
+		// Adding the commands to the root command makes them actually callable on the commandline
-		rootCommand.AddCommand(convertCommand);
+		rootCommand.Subcommands.Add(cleanCommand);
-
+		rootCommand.Subcommands.Add(convertCommand);
-		var parser = new CommandLineBuilder(rootCommand)
-			.UseDefaults()
-			.Build();
-
-		parser.Invoke(args);
 
+		// Parse the commandline and immediately execute.
+		rootCommand.Parse(args).Invoke();
 
 		TotalExecutionTime.Stop();
 		Log.Information("TotalExecutionTime {time:000}ms", TotalExecutionTime.ElapsedMilliseconds);
 
+		// Providing there were no early exits it is best to properly close the log before we exit.
 		Log.CloseAndFlush();
 		return 0;
 	}
 
-	static int Convert(DirectoryInfo inputDir, DirectoryInfo outputDir)
+	static int Convert(DirectoryInfo ProjectDirectory)
 	{
+		Log.Information("Convert command was called, beginning conversion.");
+
+		// WARN: This is only temporary as Spectre.Console does not recognise some Linux terminals
+		// TODO: A better solution that checks the terminal value and sets this option should be added in the future.
 		AnsiConsole.Console.Profile.Capabilities.Ansi = true;
 
+
+		ProjectSettings settings = GetProjectSettings(ProjectDirectory);
+
 		List<SiteFile> siteFiles = new();
 
-		Utils.GetFiles(inputDir).ForEach(x => siteFiles.Add(new SiteFile(x)));
+		Utils.GetFiles(settings.InputDirectory).ForEach(x => {
-		Log.Information("SiteFiles: {@sf} {count}", siteFiles, siteFiles.Count);
+				siteFiles.Add(new SiteFile(x));
+				Log.Debug("Found file {file}",x.FullName);
+				});
+		Log.Information("SiteFiles Found {count}", siteFiles.Count);
 
-		Console.WriteLine($"Converting {siteFiles.Count} files from {inputDir.FullName} to {outputDir.FullName}");
+		Console.WriteLine($"Converting {siteFiles.Count} files from {settings.InputDirectory.FullName} to {settings.OutputDirectory.FullName}");
-		RuntimeSettings settings = new(inputDir,outputDir);
 
 
 		Dictionary<string,bool> fileStatus = new();
-		Log.Debug("fileStatus {@fileStatus}",fileStatus);
 
 		AnsiConsole.Progress()
 			.AutoRefresh(true)
@@ -164,15 +178,12 @@ class Program
 						Log.Warning("{name} Failed...",siteFiles[i].FullName);
 					    tasks[i].Description += " [red]FAILED[/]";
 					}
-					Log.Information("adding {@siteFile} conversion status to fileStatus", siteFiles[i]);
+					Log.Information("adding {siteFile} conversion status to fileStatus", siteFiles[i].FullName);
-					Log.Debug("FileStatus {@fileStatus}",fileStatus);
 					fileStatus.Add(siteFiles[i].FullName,res);
 					overallTask.Increment(1);
 				}
 			});
 
-		Log.Information("Conversion Status {@status}", fileStatus);
-
 		var Failed = fileStatus.Where(x => x.Value == false);
 		if ( Failed.Count() > 0)
 		{
@@ -183,41 +194,120 @@ class Program
 				AnsiConsole.MarkupLine("[yellow]See log for more details[/]");
 			}
 		}
-
+		EnforceConsistency(settings);
 		return 0;
 	}
 
-	static int Clean(DirectoryInfo outputDir)
+	static int Clean(DirectoryInfo ProjectDirectory)
 	{
-		if (!outputDir.Exists)
+		Log.Information("Clean command was called, Beginning cleaning");
+
+		ProjectSettings settings = GetProjectSettings(ProjectDirectory);
+
+		if (!settings.OutputDirectory.Exists)
 		{
-			Log.Warning("Not deleting {dir} as it doesn't exist",outputDir.FullName);
+			Log.Warning("Not deleting {dir} as it doesn't exist",settings.OutputDirectory.FullName);
-			AnsiConsole.MarkupLineInterpolated($"[bold][[[yellow]Warning[/]]][/] Not cleaning [blue]\"{outputDir}\"[/] as it does not exist.");
+			AnsiConsole.MarkupLineInterpolated($"[bold][[[yellow]Warning[/]]][/] Not cleaning [blue]\"{settings.OutputDirectory.FullName}\"[/] as it does not exist.");
 			return 0; // success because it doesn't exist.
 		}
 		try
 		{
-			Log.Information("Cleaning {dir}",outputDir.FullName);
+			Log.Information("Cleaning {dir}",settings.OutputDirectory.FullName);
-			AnsiConsole.MarkupInterpolated($"Cleaning [blue]\"{outputDir.FullName}\"[/]");
+			AnsiConsole.MarkupInterpolated($"Cleaning [blue]\"{settings.OutputDirectory.FullName}\"[/]");
-			outputDir.Delete(recursive: true);
+			settings.OutputDirectory.Delete(recursive: true);
-			outputDir.Create();
+			settings.OutputDirectory.Create();
 			AnsiConsole.MarkupLine(" [bold][[[green]OK[/]]][/]");
-			AnsiConsole.MarkupLineInterpolated($"\t[grey]>>[/] [green]All files in {outputDir.FullName} purged successfully[/]");
+			AnsiConsole.MarkupLineInterpolated($"\t[grey]>>[/] [green]All files in {settings.OutputDirectory.FullName} purged successfully[/]");
 			return 0;
 		}
 		catch (System.Security.SecurityException e)
 		{
 			AnsiConsole.MarkupLine(" [bold][[[red]Fail[/]]][/]");
 			AnsiConsole.MarkupLine("[orangered1]See log for more details about what went wrong.[/]");
-			Log.Error(e, "Failed to delete directory {dir} due to permission error.", outputDir.FullName);
+			Log.Error(e, "Failed to delete directory {dir} due to permission error.", settings.OutputDirectory.FullName);
 			return 1;
 		}
 		catch (Exception e)
 		{
 			AnsiConsole.MarkupLine(" [red][[[bold]Fail[/]]][/]");
 			AnsiConsole.MarkupLine("[orangered1]See log for more details about what went wrong.[/]");
-			Log.Error(e, "Failed to delete/create directory {dir}", outputDir.FullName);
+			Log.Error(e, "Failed to delete/create directory {dir}", settings.OutputDirectory.FullName);
 			return 1;
 		}
 	}
+
+	static void EnforceConsistency(ProjectSettings projectSettings)
+	{
+		AnsiConsole.MarkupLine("[blue]Checking for stale files[/]");
+		// Grab the metadata.
+		List<string> staleMetadataFiles = new();
+		var metadata = SiteFile.getMetadata(projectSettings);
+		// Read the metadata.
+		foreach (var entry in metadata)
+		{
+			var file = entry.Key;
+			Log.Information("Checking if {f} has been deleted", file);
+			if (!File.Exists(file))
+			{
+				Log.Information("{f} HAS been deleted", file);
+
+				// what should that files new name be.
+				var newFileName = Conversions.GetNewName(new FileInfo(file),projectSettings);
+				try{
+					// Delete that file and mark the metadata for removal.
+					File.Delete(newFileName);
+					AnsiConsole.MarkupLineInterpolated($"[red]Deleted [blue]{newFileName}[/][/]");
+					Log.Information("Deleted {f}",newFileName);
+					staleMetadataFiles.Add(file);
+				}
+				catch (Exception e)
+				{
+					Log.Error(e,"Could not delete {f}",newFileName);
+				}
+			}
+			SiteFile.invalidateMetadata(staleMetadataFiles,projectSettings);
+		}
+	}
+
+
+	static ProjectSettings GetProjectSettings(DirectoryInfo ProjectDirectory)
+	{
+		// TODO: implement proper error handling where file access is performed.
+
+		Log.Information("{projectdir} => fullname {pdfn}",ProjectDirectory, ProjectDirectory.FullName);
+		FileInfo projectFile = new (Path.Combine(ProjectDirectory.FullName,"cssitegen.json"));
+
+
+		if (!projectFile.Exists)
+		{
+		    Log.Fatal("Cannot locate project file {pf} in {dir}",projectFile,ProjectDirectory);
+			AnsiConsole.MarkupLineInterpolated($"[red]No project file found in [yellow]{ProjectDirectory}[/][/]");
+			Environment.Exit(1);
+		}
+
+		Log.Information("Located Project File {pf}",projectFile.FullName);
+		ProjectSettings? projectSettings = JsonSerializer
+			.Deserialize<ProjectSettings>(
+					projectFile
+					.OpenText()
+					.ReadToEnd(),
+					SourceGenerationContext.Default.ProjectSettings
+		);
+
+		if (projectSettings is null)
+		{
+		    Log.Fatal("Cannot deserialize projectFile");
+			Environment.Exit(1);
+		}
+		projectSettings.setProjectRoot(ProjectDirectory);
+
+		return projectSettings;
+	}
+
+}
+
+[JsonSourceGenerationOptions(WriteIndented = true)]
+[JsonSerializable(typeof(ProjectSettings))]
+internal partial class SourceGenerationContext : JsonSerializerContext
+{
 }

ProjectSettings/ProjectSettings.cs

@@ -0,0 +1,49 @@
+using System.Text.Json.Serialization;
+// project settings is a user accessible config to set the Source and destination of a site
+// This may include more scope in the future such as holding the site base address etc..
+
+public class ProjectSettings
+{
+	// The Source and Destination need to be public for the json constructor to work properly.
+	private DirectoryInfo? _ProjectRoot;
+    public string Source {get; private set;}
+	public string Destination {get; private set;}
+	public string? BaseUrl {get; private set;}
+	public string? SiteName {get; private set;}
+
+	public DirectoryInfo InputDirectory {get {
+		if (_ProjectRoot is null)
+		{
+		    return new(Source);
+		}
+		return new(Path.Combine(_ProjectRoot.FullName,Source));
+	}}
+	public DirectoryInfo OutputDirectory {get {
+		if (_ProjectRoot is null)
+		{
+		    return new(Destination);
+		}
+		return new(Path.Combine(_ProjectRoot.FullName,Destination));
+	}}
+
+	[JsonConstructor]
+	public ProjectSettings(string source, string destination, string baseUrl, string siteName) {
+		Source = source;
+		Destination = destination;
+		BaseUrl = baseUrl;
+		SiteName = siteName;
+	}
+
+	public void setProjectRoot(string projectRoot) {
+		_ProjectRoot = new(projectRoot);
+	}
+	public void setProjectRoot(DirectoryInfo projectRoot) {
+		_ProjectRoot = projectRoot;
+	}
+
+	/*
+	 * public void setBaseUrl(string baseUrl) {
+	 *     BaseUrl = baseUrl;
+	 * }
+	 */
+}

Readme.md

@@ -0,0 +1,89 @@
+# CsSiteGen
+A relatively simple (for now) static site "generator".
+The heavy lifting of this project is actually performed by `pandoc` so you
+better make sure you install it on your system.
+
+## How to use
+The configuration for a site is stored in a file called `cssitegen.json`
+this file can technically be located anywhere but the recommended directory
+structure is as follows:
+```
+-Project-Root
+ |
+ |-Source_Directory
+ | |
+ | |- [source files...]
+ |
+ |-Destination_Directory
+ |
+ |-cssitegen.json
+```
+This makes the file much simpler to write, However with fully specified
+paths you can actually place the files anywhere.
+
+### Structure of `cssitegen.json`
+All `cssitegen.json` files must specify at minimum the source, and
+destination directories, If the baseurl is omitted it will simply be null.
+You must also ensure that you follow the JSON format properly.
+The following fields are used in a file
+- Source - a string that locates the source files. This can either be the
+full path or a relative path.
+- Destination - As above but this is where the output files will go.
+- BaseUrl - a string or `null` this will be used to replace the string
+`%BASEURL%` in supported files. (Depending on your usage you may need to
+specify the protocol)
+
+#### Example file
+```json
+{
+    "Source" : "./Source",
+    "Destination" : "./Destination",
+    "BaseUrl" : "https://example.org"
+}
+```
+
+### Executing the program
+Currently the program has two subcommands that can be used, and an optional
+project argument, if not specified the program assumes that the project is
+the current directory.
+
+The program is called like this
+```sh
+cssitegen SUBCOMMAND [--project "directory"]
+```
+#### convert
+This subcommand performs conversion of the files.
+It only considers source files for conversion if they are new or have been
+changed since the last run of the program.
+Therefore if you change the `BaseUrl` or the template file you will need to
+clean and convert your entire project.
+
+#### clean
+This subcommand purges the output directory, You can of course do this
+manually but for convenience this is implemented here.
+
+### Templating
+The templating system is managed by `pandoc` so please check the
+documentation for `pandoc` to learn about the format.
+
+As for where to place the template files,
+for every file converted using `pandoc` the program will attempt to locate
+the appropriate template named as `.template`, it first looks in the
+directory of the source file, and then works its way up the directory tree
+until it hits the root directory, using the first template it finds.
+This means that if you want different templates for some sections of your
+site you can do that, and other sections will fallback to your root
+template.
+_If you don't specify a template you will get the `pandoc` defaults_
+
+### BaseUre replacement
+Currently the string `%BASEURL%` will be replaced in `.md` `.html` and
+template files. This feature is something you will definitely want to use,
+unless you want to structure everything to the point you only need relative
+links. (I personally found this almost impossible)
+
+## Future plans
+- Automatic page generation using pre-process steps and temporary files. E.G Contents pages, index pages etc...(DIFFICULT)
+- Detection of changes to the `BaseUrl` and any templates. (MEDIUM)
+- Allow expansion of conversion operations (DIFFICULT)
+- Allow customisation of filetypes that can have `%BASEURL%` replaced (EASY-MEDIUM)

RuntimeSettings/RuntimeSettings.cs

@@ -1,29 +0,0 @@
-namespace csSiteGen;
-
-
-/// <summary>
-/// Class <c>RuntimeSettings</p> Contains all the settings that could be loaded from the commandline.
-/// </summary>
-public class RuntimeSettings {
-	public DirectoryInfo InputDirectory {get; private set;}
-	public DirectoryInfo OutputDirectory {get; private set;}
-
-
-	public RuntimeSettings(string inputDirectory, string outputDirectory){
-		InputDirectory = new DirectoryInfo(inputDirectory);
-		OutputDirectory = new DirectoryInfo(outputDirectory);
-
-		/* NOTE: it is the responisbility of the UI code to check the values passed are good.
-		*/
-	}
-
-
-	public RuntimeSettings(DirectoryInfo inputDirectory, DirectoryInfo outputDirectory){
-		InputDirectory = inputDirectory;
-		OutputDirectory = outputDirectory;
-
-		/* NOTE: it is the responisbility of the UI code to check the values passed are good.
-		*/
-	}
-
-}

SiteFile/SiteFile.ConverterFunctions.cs

@@ -6,32 +6,37 @@ namespace csSiteGen;
 public static class Conversions{
 
 
-	public delegate bool ConvertFunc(FileInfo file, RuntimeSettings settings);
+	public delegate bool ConvertFunc(FileInfo file, ProjectSettings settings);
 
 	/// <summary>
 	/// A Mapping of filetype to ConvertFunc.
 	/// </summary>
-	public static readonly Dictionary<string,ConvertFunc> Mappings = new(){
+	public static readonly Dictionary<string,(ConvertFunc function,string extension)> Mappings = new(){
-		{".md", Pandoc},
+		{".md", (Pandoc, ".html")},
+	};
+
+	private static readonly string[] StringReplaceFiletypes = {
+		".md",
+		".html"
 	};
 
 
 	/// <summary>
 	///	TEST FUNCTION.
 	/// </summary>
-	public static bool NoOp(FileInfo file, RuntimeSettings settings){
+	public static bool NoOp(FileInfo file, ProjectSettings settings){
 		Log.Information("Performing NoOp Conversion");
-		string newName = GetNewName(file,settings,"NoOp");
+		string newName = GetNewName(file,settings);
 		Log.Debug("{FullName} -> {newName}",file.FullName,newName);
 		Thread.Sleep(1500);
 		return true;
 	}
 
 	/// <summary>
-	/// Copy the file verbatim
+	/// Copy the file verbatim (doing any baseurl replacements if needed)
 	/// </summary>
-	public static bool RawCpy(FileInfo file, RuntimeSettings settings){
+	public static bool RawCpy(FileInfo file, ProjectSettings settings){
-		FileInfo newPath = new FileInfo(GetNewName(file,settings,null));
+		FileInfo newPath = new FileInfo(GetNewName(file,settings));
 
 		Log.Information("RawCpy: Copying {file} to {dest}",file.FullName, newPath.FullName);
 
@@ -41,8 +46,15 @@ public static class Conversions{
 		}
 
 		try {
+			if (StringReplaceFiletypes.Contains(file.Extension))
+			{
+				File.WriteAllText(newPath.FullName, StringReplace(file, settings));
+			}
+			else
+			{
 				file.CopyTo(newPath.FullName, overwrite: true);
 			}
+		}
 		catch (Exception e){
 			Log.Fatal(e,"Copy Failed");
 			return false;
@@ -53,7 +65,12 @@ public static class Conversions{
 	/// <summary>
 	/// Execute pandoc on the file, automatically detecting the template to use.
 	/// </summary>
-	public static bool Pandoc(FileInfo file, RuntimeSettings settings){
+	public static bool Pandoc(FileInfo file, ProjectSettings settings){
+		// NOTE: Some of the code later where the tmpfile is created for baseurl replacement may be too safe.
+		// the extension checks may be unnecessary, but this depends on if this function will be retooled to run pandoc for different conversions.
+		// for now I have take the safer approach, but the leaner approach may be used in the future when the project is more mature
+
+
 		Log.Information("Attempting to convert {file} using pandoc",file.Name);
 
 		// Look for pandoc
@@ -91,7 +108,37 @@ public static class Conversions{
 			searchDir = searchDir.Parent;
 		} while (searchDir != settings.InputDirectory); // Check last as we want to search the InputDirectory
 
-		string pandocArgs = $"{file.FullName} -o {GetNewName(file,settings,".html")}";
+		// the empty string is used as it has a defined identity
+		string tmpFile = string.Empty;
+		if (StringReplaceFiletypes.Contains(file.Extension))
+		{
+			Log.Information("calling string replace for file {f}",file.FullName);
+		    tmpFile = Path.Join(Path.GetTempPath(),"pandoc",file.Name);
+			Directory.CreateDirectory(Path.GetDirectoryName(tmpFile)!); // NOTE: It is practially impossible that this would actually return null
+			File.Create(tmpFile).Close(); // TODO: Use the filestream provided by File.Create within a using block to write the text
+			File.WriteAllText(tmpFile,StringReplace(file,settings));
+
+			if (template is not null)
+			{
+				Log.Information("calling string replace for template file");
+				string tmpTemplateFile = Path.Join(Path.GetTempPath(),"pandoc",template.Name);
+				Directory.CreateDirectory(Path.GetDirectoryName(tmpTemplateFile)!); // NOTE: It is practially impossible that this would actually return null
+				File.Create(tmpTemplateFile).Close(); // TODO: Use the filestream provided by File.Create within a using block to write the text
+				File.WriteAllText(tmpTemplateFile,StringReplace(template,settings));
+				template = new(tmpTemplateFile);
+			}
+		}
+
+		string pandocArgs;
+		// If we have created a temporary file we need to ensure that we use it.
+		if (!string.IsNullOrEmpty(tmpFile))
+		{
+			pandocArgs = $"{tmpFile} -o {GetNewName(file,settings)}";
+		}
+		else
+		{
+			pandocArgs = $"{file.FullName} -o {GetNewName(file,settings)}";
+		}
 
 		if (template is not null)
 		{
@@ -103,7 +150,24 @@ public static class Conversions{
 			Log.Warning("Pandoc template for {file} not found",file.Name);
 		}
 
-		return RunExternalProgram(pandoc,pandocArgs);
+		pandocArgs += " --from markdown+raw_attribute ";
+		if (!string.IsNullOrEmpty(settings.SiteName))
+		{
+			// This is used in my template to add the sitename to the title element.
+			pandocArgs += $" --metadata=\"SiteName:{settings.SiteName}\"";
+		}
+		if (!Directory.Exists(Path.GetDirectoryName(GetNewName(file,settings))))
+		{
+		   Directory.CreateDirectory(Path.GetDirectoryName(GetNewName(file,settings))!);
+		}
+
+		bool pandocReturn = RunExternalProgram(pandoc,pandocArgs);
+		// If we made a tmpfile delete it after running pandoc against it.
+		if (!string.IsNullOrEmpty(tmpFile))
+		{
+		    File.Delete(tmpFile);
+		}
+		return pandocReturn;
 
 	}
 
@@ -138,8 +202,8 @@ public static class Conversions{
 
 			RunProgram.WaitForExit();
 
-			Log.Debug("{program} stdout {stdout}", program, stdout);
+			Log.Debug("{program} STDOUT:\n{stdout}", program, stdout);
-			Log.Debug("{program} stderr {stderr}", program, stderr);
+			Log.Debug("{program} STDERR:\n{stderr}", program, stderr);
 
 			if (RunProgram.ExitCode != 0)
 			{
@@ -150,9 +214,44 @@ public static class Conversions{
 		return true;
 	}
 
-	private static string GetNewName(FileInfo file, RuntimeSettings settings, string? newExtension){
+	public static string GetNewName(FileInfo file, ProjectSettings settings){
+		var newExtension = Mappings.GetValueOrDefault(file.Extension,(RawCpy,file.Extension)).extension;
 		return file.FullName
 			.Replace(settings.InputDirectory.FullName, settings.OutputDirectory.FullName)
-			.Replace(file.Extension,newExtension ?? file.Extension);
+			.Replace(file.Extension,newExtension);
 	}
+
+	private static string StringReplace(FileInfo file, ProjectSettings settings){
+		Log.Information("Doing StringReplace for {f}", file.FullName);
+		// Read the file
+		using (StreamReader FileReader = file.OpenText())
+		{
+			string filestring = FileReader.ReadToEnd();
+
+			if (settings.BaseUrl is null)
+			{
+				Log.Warning("BaseUrl is null, replacing %BASEURL% with nothing.");
+				filestring = filestring.Replace("%BASEURL%","");
+			}
+			else
+			{
+				Log.Information("Replacing %BASEURL% with {BaseUrl}",settings.BaseUrl);
+				filestring = filestring.Replace("%BASEURL%",settings.BaseUrl);
+			}
+
+			if (settings.SiteName is null)
+			{
+			    Log.Warning("SiteName is null, replacing %SITENAME% with nothing.");
+				filestring = filestring.Replace("%SITENAME%","");
+			}
+			else
+			{
+				Log.Information("Replacing %SITENAME% with {SiteName}",settings.SiteName);
+				filestring = filestring.Replace("%SITENAME%",settings.SiteName);
+			}
+
+			return filestring;
+		}
+	}
+
 }

SiteFile/SiteFile.cs

@@ -1,4 +1,5 @@
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using Serilog;
 namespace csSiteGen;
 
@@ -11,6 +12,36 @@ public partial class SiteFile
 	Conversions.ConvertFunc ConverterFunction;
 	static Dictionary<string, DateTime>? Metadata = null;
 
+	/// <summary>
+	/// Get the metadata for the current project, loading it if not already loaded.
+	/// </summary>
+	/// <param name="settings">
+	///	The current <c>ProjectSettings</c>
+	/// </param>
+	/// <returns>
+	///	A <c>Dictionary<string,DateTime></c> that represents the metadata stored.
+	/// </returns>
+	public static Dictionary<string,DateTime> getMetadata(ProjectSettings settings) {
+		if (Metadata is null)
+		{
+			LoadMetadata(settings);
+		}
+		return Metadata?? new(); // Metadata is unlikely(if not impossible) to be null here but the compiler isn't convinced
+	}
+
+	public static void invalidateMetadata(List<string> files, ProjectSettings settings)
+	{
+		if (Metadata is null)
+		{
+		    return;
+		}
+		files.ForEach( file => {
+			Metadata.Remove(file);
+			});
+
+		SaveMetadata(settings);
+	}
+
 	/// <summary>
 	/// The name of the file, Not Guaranteed to be unique.
 	/// Use only for output and logging, never file operations,
@@ -28,17 +59,17 @@ public partial class SiteFile
 	{
 		info = fileInfo;
 
-		Log.Information("{file} extension is {ext}",fileInfo.FullName, fileInfo.Extension);
+		Log.Debug("{file} extension is {ext}",fileInfo.FullName, fileInfo.Extension);
 		// Using this Ensures that the ConverterFunction is Always set.
-		// ConverterFunctions ALWAYS accept just the FileInfo, and RuntimeSettings passed at convert time.
+		// ConverterFunctions ALWAYS accept just the FileInfo, and ProjectSettings passed at convert time.
-		ConverterFunction = Conversions.Mappings.GetValueOrDefault(info.Extension, Conversions.RawCpy);
+		ConverterFunction = Conversions.Mappings.GetValueOrDefault(info.Extension, (Conversions.RawCpy,info.Extension)).function;
 	}
 
 	/// <summary>
 	///	Convert the file, placing it in the correct place in the output directory.
 	/// If a filetype conversion is not needed, or specified, then the file is simply copied.
 	/// </summary>
-	public bool Convert(RuntimeSettings settings)
+	public bool Convert(ProjectSettings settings)
 	{
 		if (!NeedsUpdating(settings))
 		{
@@ -58,27 +89,27 @@ public partial class SiteFile
 			{
 			    Metadata.Add(info.FullName,info.LastWriteTimeUtc);
 			}
-			Log.Debug("Metadata Dictionary now {@Metadata}", Metadata);
+			Log.Debug("Metadata Dictionary now has {Metadata} items", Metadata.Count);
 			SaveMetadata(settings);
 		}
 
 		return res;
 	}
 
-	private bool NeedsUpdating(RuntimeSettings settings)
+	private bool NeedsUpdating(ProjectSettings settings)
 	{
 		if (Metadata is null)
 		{
 			LoadMetadata(settings);
 		}
 
-		// NOTE: By this point Metadata CANNOT be null as LoadMetadata would either have loaded the JSON or instantiated MetaData
+		// NOTE: By this point Metadata CANNOT be null as LoadMetadata would either have loaded the JSON or instantiated blank MetaData
-		if (Metadata!.GetValueOrDefault(info.FullName, DateTime.MinValue) == info.LastWriteTimeUtc)
+		// The compiler however is unaware of this as it uses side effects, so we tell it there is no possible null value here.
-		{
+		Log.Debug("Attempting to check metadata for file {f}",info.FullName);
-			return false;
+		Log.Debug("METADATA={MD}",Metadata!.GetValueOrDefault(info.FullName,DateTime.MinValue));
-		}
+		Log.Debug("FILETIME={FT}",info.LastWriteTimeUtc);
-
+		Log.Debug("RES={res}",(Metadata!.GetValueOrDefault(info.FullName, DateTime.MinValue) != info.LastWriteTimeUtc));
-		return true;
+		return (Metadata!.GetValueOrDefault(info.FullName, DateTime.MinValue) != info.LastWriteTimeUtc);
 	}
 
 
@@ -87,7 +118,7 @@ public partial class SiteFile
 	 * But that ensures that if you remove the output directory the site will be
 	 * Fully recreated.
 	 */
-	private void LoadMetadata(RuntimeSettings settings)
+	private static void LoadMetadata(ProjectSettings settings)
 	{
 		string metaFile = $"{settings.OutputDirectory}/.files";
 		Log.Information("Loading Metadata from {file}",metaFile);
@@ -95,8 +126,8 @@ public partial class SiteFile
 		{
 			string metaJson = File.ReadAllText(metaFile);
 			Log.Debug("Read Json {metaJson}", metaJson);
-			Metadata = JsonSerializer.Deserialize<Dictionary<string, DateTime>>(metaJson);
+			Metadata = JsonSerializer.Deserialize<Dictionary<string, DateTime>>(metaJson,SerializeMetadataContext.Default.DictionaryStringDateTime);
-			Log.Debug("Deserialized to {@Metadata}",Metadata);
+			Log.Debug("Deserialized Metadata with {c} items",Metadata!.Count);
 		}
 		catch (IOException e)
 		{
@@ -113,7 +144,7 @@ public partial class SiteFile
 		}
 	}
 
-	private void SaveMetadata(RuntimeSettings settings)
+	private static void SaveMetadata(ProjectSettings settings)
 	{
 		if (Metadata is null)
 		{
@@ -124,7 +155,7 @@ public partial class SiteFile
 		string metaJson;
 		try
 		{
-			metaJson = JsonSerializer.Serialize<Dictionary<string, DateTime>>(Metadata);
+			metaJson = JsonSerializer.Serialize<Dictionary<string, DateTime>>(Metadata,SerializeMetadataContext.Default.DictionaryStringDateTime);
 			Log.Debug("metaJson: {metaJson}",metaJson);
 		}
 		catch (JsonException e)
@@ -136,3 +167,9 @@ public partial class SiteFile
 		File.WriteAllText(metaFile, metaJson);
 	}
 }
+
+[JsonSourceGenerationOptions(GenerationMode = JsonSourceGenerationMode.Serialization)]
+[JsonSerializable(typeof(Dictionary<string,DateTime>))]
+internal partial class SerializeMetadataContext : JsonSerializerContext
+{
+}

TODO

@@ -1,5 +1,2 @@
 - Add a pre-commit or other type of hook to ensure that the Testing directory is properly cleaned and reset before commit.
-- Double check that links are processed correctly by testing against a copy of my blog source.
+	- Ensure that the .gitkeep file is placed into Testing/dst
-	- Also add the appropriate metadata to the markdown files to make sure that they are properly detected.
-	- Potentially host a local Test version to fully ensure that everything can be made to work properly.
-- Look into the possiblity of using a TemplateTemplate, And generating the pandoc template on the fly making it possible to switch out domian/prefix stuff

Testing/cssitegen.json

@@ -0,0 +1,6 @@
+{
+	"Source" : "./src",
+	"Destination" : "./dst",
+	"BaseUrl" : null,
+	"SiteName" : "Example Town"
+}

Testing/src/index.md

@@ -1,4 +1,11 @@
+---
+title: '%SITENAME%Page1'
+---
 # This is a markdown file
 
 This file is designed as a simple test to ensure that things are working
 the way I intend them to.
+%BASEURL%
+
+HERE IS SOME MORE TEXT TO ENSURE I AM NOT GOING MAD
+%SITENAME%

Utils/Utils.GetFiles.cs

@@ -4,6 +4,6 @@ public static partial class Utils {
 
 	// Abstract Directory.GetFiles to get a List as it will be easier to handle later.
 	public static List<FileInfo> GetFiles(DirectoryInfo dir){
-		return dir.GetFiles("*",SearchOption.AllDirectories).ToList();
+		return dir.GetFiles("*",SearchOption.AllDirectories).Where(x => x.Name != ".template").ToList();
 	}
 }

Utils/Utils.PathSearch.cs

@@ -3,6 +3,8 @@ namespace csSiteGen;
 
 public static partial class Utils {
 
+	// As the PathSearch utility will be called for every convertible file
+	// It has been memoized which mean subsequent calls for the same argument just return the result
 	static Dictionary<string,string> PathSearchMemo = new();
 
 	///<summary>
@@ -46,7 +48,7 @@ public static partial class Utils {
 		result = candidateExecutables.First();
 		PathSearchMemo.Add(Program,result);
 		Log.Information("Found {program} at {path}",Program, result);
-		Log.Debug("Adding {@entry} to PathSearchMemo", PathSearchMemo.Last());
+		Log.Debug("Adding to PathSearchMemo", PathSearchMemo.Last().Value);
 		return result;
 	}
 }

csSiteGen.csproj

@@ -3,42 +3,47 @@
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
 		
-		<Version Condition="'$(RELEASE_VERSION)' != ''">$(RELEASE_VERSION)</Version>
+		<TargetFramework>net10.0</TargetFramework>
-		<VersionPrefix Condition="'$(RELEASE_VERSION)' == ''">0.0.1</VersionPrefix>
+		<ImplicitUsings>enable</ImplicitUsings>
-		<VersionSuffix Condition="'$(RELEASE_VERSION)' == ''">$([System.DateTime]::UtcNow.ToString(`yyyyMMdd-HHmm`))</VersionSuffix>
+		<Nullable>enable</Nullable>
+
+		<PublishSingleFile>True</PublishSingleFile>
+		<SelfContained>True</SelfContained>
+		<PublishTrimmed>True</PublishTrimmed>
 
 		
 		<OutputPath>bin\$(Configuration)\</OutputPath>
 
-		<TargetFramework>net8.0</TargetFramework>
+		<Version Condition="'$(RELEASE_VERSION)' != ''">$(RELEASE_VERSION)</Version>
-		<ImplicitUsings>enable</ImplicitUsings>
+		<VersionPrefix Condition="'$(RELEASE_VERSION)' == ''">0.0.4</VersionPrefix>
-		<Nullable>enable</Nullable>
+		<VersionSuffix Condition="'$(RELEASE_VERSION)' == ''">$([System.DateTime]::UtcNow.ToString(`yyyyMMdd-HHmm`))</VersionSuffix>
 	</PropertyGroup>
 
-	<ItemGroup>
-		<PackageReference Include="Serilog" Version="3.1.1" />
-		<PackageReference Include="Serilog.Sinks.Console" Version="5.0.1" />
-		<PackageReference Include="Serilog.Sinks.File" Version="5.0.0" />
-		<PackageReference Include="spectre.console" Version="0.48.0" />
-		<PackageReference Include="system.commandline" Version="2.0.0-beta4.22272.1" />
-	</ItemGroup>
 
 	<PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
 		<!--	Here we define the Debug Build.
 		-->
-		<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+		<TreatWarningsAsErrors>false</TreatWarningsAsErrors>
+		<DebugSymbols>true</DebugSymbols>
+		<DebugType>full</DebugType>
+		<DefineDebug>true</DefineDebug>
 	</PropertyGroup>
 
 	<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
-		<!--	Here we define the release build.
-			The Release Build will be a Single file App
-			The Release Build will also do -Werror as I don't want to release shitty code
-			The Release Build will also be R2R as I don't want it to depend on the framework
-			NOTE: This build requires specifying a platform
-		-->
 		<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-		<PublishReadyToRun>true</PublishReadyToRun>
+		<SuppressTrimAnalysisWarnings>false</SuppressTrimAnalysisWarnings>
-		<PublishSingleFile>true</PublishSingleFile>
+		<TrimmerSingleWarn>false</TrimmerSingleWarn>
-		<SelfContained>true</SelfContained>
+		<DebugSymbols>false</DebugSymbols>
+		<DefineDebug>false</DefineDebug>
+
 	</PropertyGroup>
+	
+	<ItemGroup>
+		<PackageReference Include="Serilog" Version="4.3.0" />
+		<PackageReference Include="Serilog.Sinks.Console" Version="6.1.1" />
+		<PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
+		<PackageReference Include="spectre.console" Version="0.54.0" />
+		<PackageReference Include="system.commandline" Version="2.0.1" />
+	</ItemGroup>
+
 </Project>

meta/releaseNotes

@@ -0,0 +1,11 @@
+# Minor version bump
+
+## New Features:
+- None
+
+## Fixed Bugs:
+- None
+
+## Other Notes:
+- Upgraded dependencies
+	- Now using stable system.commandline