From 4d80d36f00611a3a1196b5303a63bdc7e34a9880 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 17:40:16 +0500 Subject: [PATCH 01/20] Provide a public API This also introduces a simple program, md2gmn, that is meant for testing the renderer on Markdown files. Nonetheless, it can be used as a standalone tool as well. --- cmd/gmnhg/main.go | 52 +--------------------------------------------- cmd/md2gmn/main.go | 35 +++++++++++++++++++++++++++++++ go.mod | 5 +---- go.sum | 2 -- render.go | 16 ++++++++++++++ 5 files changed, 53 insertions(+), 57 deletions(-) create mode 100644 cmd/md2gmn/main.go create mode 100644 render.go diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index 51543b5..67fb969 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -3,56 +3,6 @@ // TODO: it is yet to actually do that. package main -import ( - "fmt" - - "git.tdem.in/tdemin/gmnhg/internal/gemini" - "github.com/davecgh/go-spew/spew" - "github.com/gomarkdown/markdown" - "github.com/gomarkdown/markdown/parser" -) - -var text = ` -# Some document - -This is some markdown [text](https://tdem.in). This is some more text. - -![This is some image](https://tdem.in/favicon.ico) - -[This is some full-blown link.](https://tdem.in/nyaa) - -This is some more plain text. More of it! - -+ Unordered list item -+ Another list item - * Indented list item. - * Another one. -+ Third. - -1. Ordered list item. -2. Another one. - * and another inset list. - * text. -3. Yay. - -` + "```" + ` -some preformatted text -another line of preformatted text - -more lines of preformatted text -` + "```" + ` - -## Subheading 2 - -More text! - -> Some weird blockquote. More text. -> More quote text. -` - func main() { - ast := markdown.Parse([]byte(text), parser.NewWithExtensions(parser.CommonExtensions)) - spew.Dump(ast) - geminiContent := markdown.Render(ast, gemini.NewRenderer()) - fmt.Printf("---\noriginal:\n---\n%s---\ngemini:\n---\n%s", text, geminiContent) + println("in development") } diff --git a/cmd/md2gmn/main.go b/cmd/md2gmn/main.go new file mode 100644 index 0000000..0bf33f5 --- /dev/null +++ b/cmd/md2gmn/main.go @@ -0,0 +1,35 @@ +// md2gmn converts Markdown text files to text/gemini. +package main + +import ( + "flag" + "io/ioutil" + "os" + + gemini "git.tdem.in/tdemin/gmnhg" +) + +func main() { + var ( + input string + file *os.File + ) + flag.StringVar(&input, "f", "", "input file") + flag.Parse() + + if input != "" { + var err error + file, err = os.Open(input) + if err != nil { + panic(err) + } + } else { + file = os.Stdin + } + text, err := ioutil.ReadAll(file) + if err != nil { + panic(err) + } + + os.Stdout.Write(gemini.RenderMarkdown(text)) +} diff --git a/go.mod b/go.mod index 17174ca..8f09c36 100644 --- a/go.mod +++ b/go.mod @@ -2,7 +2,4 @@ module git.tdem.in/tdemin/gmnhg go 1.15 -require ( - github.com/davecgh/go-spew v1.1.1 - github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b -) +require github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b diff --git a/go.sum b/go.sum index 88392a2..6b74de0 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,3 @@ -github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= -github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b h1:Om9FdD4lzIJELyJxwr9EWSjaG6GMUNS3iebnhrGevhI= github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b/go.mod h1:aii0r/K0ZnHv7G0KF7xy1v0A7s2Ljrb5byB7MO5p6TU= golang.org/dl v0.0.0-20190829154251-82a15e2f2ead/go.mod h1:IUMfjQLJQd4UTqG1Z90tenwKoCX93Gn3MAQJMOSBsDQ= diff --git a/render.go b/render.go new file mode 100644 index 0000000..513d0c3 --- /dev/null +++ b/render.go @@ -0,0 +1,16 @@ +package gemini + +import ( + "git.tdem.in/tdemin/gmnhg/internal/gemini" + "github.com/gomarkdown/markdown" + "github.com/gomarkdown/markdown/parser" +) + +// RenderMarkdown converts Markdown text to text/gemini using gomarkdown. +// +// gomarkdown doesn't return any errors, nor does this function. +func RenderMarkdown(md []byte) (geminiText []byte) { + ast := markdown.Parse(md, parser.NewWithExtensions(parser.CommonExtensions)) + geminiContent := markdown.Render(ast, gemini.NewRenderer()) + return geminiContent +} From 32ec381d73e0dca5ea6931ea15b9ef01ec5f14cd Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 18:27:38 +0500 Subject: [PATCH 02/20] Add README and license code under GPLv3 --- COPYING | 674 ++++++++++++++++++++++++++++++++++++ README.md | 49 +++ cmd/md2gmn/main.go | 15 + internal/gemini/renderer.go | 15 + render.go | 17 + 5 files changed, 770 insertions(+) create mode 100644 COPYING create mode 100644 README.md diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..136a9c7 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Hugo-to-Gemini converter + +This repo holds a converter of Hugo Markdown posts to +[text/gemini][Gemtext] (also named Gemtext in this README). The +converter is supposed to make people using [Hugo](https://gohugo.io)'s +entrance to [Project Gemini][Gemini], the alternate web, somewhat +simpler. + +[Gemini]: https://gemini.circumlunar.space +[Gemtext]: https://gemini.circumlunar.space/docs/specification.html + +At this stage of development this repo contains the actual renderer +(`internal/gemini`) and the `md2gmn` program that converts Markdown +input to Gemtext and is supposed to facilitate testing. + +The renderer is somewhat hasty, and is NOT supposed to be able to +convert the entirety of possible Markdown to Gemtext (as it's not +possible to do so, considering Gemtext is a lot simpler than Markdown), +but instead a selected subset of it, enough for conveying your mind in +Markdown. + +The renderer uses the [gomarkdown][gomarkdown] library for parsing +Markdown. + +[gomarkdown]: https://github.com/gomarkdown/markdown + +## md2gmn + +This program reads Markdown input from either text file (if `-f +filename` is given), or stdin. The resulting Gemtext goes to stdout. + +``` +Usage of md2gmn: + -f string + input file +``` + +## TODO + ++ [x] convert Markdown text to Gemtext ++ [ ] prepend contents of YAML front matter to Gemtext data ++ [ ] render all Hugo content files to Gemtext in accordance with front + matter data and Hugo config + +## License + +This program is redistributed under the terms and conditions of the GNU +General Public License, more specifically under version 3 of the +License. For details, see [COPYING](COPYING). diff --git a/cmd/md2gmn/main.go b/cmd/md2gmn/main.go index 0bf33f5..5a30380 100644 --- a/cmd/md2gmn/main.go +++ b/cmd/md2gmn/main.go @@ -1,3 +1,18 @@ +// This file is part of gmnhg. + +// gmnhg 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. + +// gmnhg 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 gmnhg. If not, see . + // md2gmn converts Markdown text files to text/gemini. package main diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index 2301359..c6059d1 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -1,3 +1,18 @@ +// This file is part of gmnhg. + +// gmnhg 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. + +// gmnhg 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 gmnhg. If not, see . + // Package gemini contains an implementation of markdown => text/gemini // renderer for github.com/gomarkdown/markdown. package gemini diff --git a/render.go b/render.go index 513d0c3..5bbe75e 100644 --- a/render.go +++ b/render.go @@ -1,3 +1,20 @@ +// This file is part of gmnhg. + +// gmnhg 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. + +// gmnhg 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 gmnhg. If not, see . + +// Package gemini provides functions to convert Markdown files to +// Gemtext. package gemini import ( From 326dc631129ab62ea18542663a502eb82638dcc8 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Mon, 9 Nov 2020 00:48:54 +0500 Subject: [PATCH 03/20] Add support for inline code blocks --- internal/gemini/renderer.go | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index c6059d1..d4abc01 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -175,6 +175,9 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) (no if text, ok := child.(*ast.Text); ok { r.text(w, text) } + if inlineBlock, ok := child.(*ast.Code); ok { + r.text(w, inlineBlock) + } } if !onlyElementIsLink { w.Write(lineBreak) @@ -244,8 +247,10 @@ func (r Renderer) list(w io.Writer, node *ast.List, level int) { } } -func (r Renderer) text(w io.Writer, node *ast.Text) { - w.Write(node.Literal) +func (r Renderer) text(w io.Writer, node ast.Node) { + if node := node.AsLeaf(); node != nil { + w.Write(node.Literal) + } } // RenderNode implements Renderer.RenderNode(). From b181afc5f11fcfe913efa8986f2e3cd005a7a5cd Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Tue, 10 Nov 2020 00:51:11 +0500 Subject: [PATCH 04/20] Add YAML front matter parsing support Fixes #1. Only a subset of Hugo front matter props are supported, namely title/date. --- cmd/md2gmn/main.go | 10 +++++-- go.mod | 5 +++- go.sum | 3 ++ internal/gemini/renderer.go | 32 ++++++++++++++++---- render.go | 60 ++++++++++++++++++++++++++++++++----- 5 files changed, 93 insertions(+), 17 deletions(-) diff --git a/cmd/md2gmn/main.go b/cmd/md2gmn/main.go index 5a30380..3d7ed9a 100644 --- a/cmd/md2gmn/main.go +++ b/cmd/md2gmn/main.go @@ -13,7 +13,8 @@ // You should have received a copy of the GNU General Public License // along with gmnhg. If not, see . -// md2gmn converts Markdown text files to text/gemini. +// md2gmn converts Markdown text files to text/gemini. It panics on +// invalid input. package main import ( @@ -46,5 +47,10 @@ func main() { panic(err) } - os.Stdout.Write(gemini.RenderMarkdown(text)) + geminiContent, err := gemini.RenderMarkdown(text) + if err != nil { + panic(err) + } + + os.Stdout.Write(geminiContent) } diff --git a/go.mod b/go.mod index 8f09c36..19fa428 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,7 @@ module git.tdem.in/tdemin/gmnhg go 1.15 -require github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b +require ( + github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b + gopkg.in/yaml.v2 v2.3.0 +) diff --git a/go.sum b/go.sum index 6b74de0..08d7486 100644 --- a/go.sum +++ b/go.sum @@ -1,3 +1,6 @@ github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b h1:Om9FdD4lzIJELyJxwr9EWSjaG6GMUNS3iebnhrGevhI= github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b/go.mod h1:aii0r/K0ZnHv7G0KF7xy1v0A7s2Ljrb5byB7MO5p6TU= golang.org/dl v0.0.0-20190829154251-82a15e2f2ead/go.mod h1:IUMfjQLJQd4UTqG1Z90tenwKoCX93Gn3MAQJMOSBsDQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU= +gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index d4abc01..5b1792e 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -22,6 +22,7 @@ import ( "bytes" "fmt" "io" + "time" "github.com/gomarkdown/markdown/ast" ) @@ -35,14 +36,30 @@ var ( itemIndent = []byte{'\t'} ) +const timestampFormat = "2006-01-02 15:04" + +// Metadata provides data necessary for proper post rendering. +type Metadata interface { + Title() string + Date() time.Time +} + // Renderer implements markdown.Renderer. -type Renderer struct{} +type Renderer struct { + Metadata Metadata +} // NewRenderer returns a new Renderer. func NewRenderer() Renderer { return Renderer{} } +// NewRendererWithMetadata returns a new Renderer initialized with post +// metadata. +func NewRendererWithMetadata(m Metadata) Renderer { + return Renderer{Metadata: m} +} + func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { if entering { w.Write(linkPrefix) @@ -290,12 +307,15 @@ func (r Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.Walk return ast.GoToNext } -// RenderHeader implements Renderer.RenderHeader(). +// RenderHeader implements Renderer.RenderHeader(). It renders metadata +// at the top of the post if any has been provided. func (r Renderer) RenderHeader(w io.Writer, node ast.Node) { - // likely doesn't need any code + if r.Metadata != nil { + // TODO: Renderer.RenderHeader: check whether date is mandatory + // in Hugo + w.Write([]byte(fmt.Sprintf("# %s\n\n%s\n\n", r.Metadata.Title(), r.Metadata.Date().Format(timestampFormat)))) + } } // RenderFooter implements Renderer.RenderFooter(). -func (r Renderer) RenderFooter(w io.Writer, node ast.Node) { - // likely doesn't need any code either -} +func (r Renderer) RenderFooter(w io.Writer, node ast.Node) {} diff --git a/render.go b/render.go index 5bbe75e..ab1d7f7 100644 --- a/render.go +++ b/render.go @@ -14,20 +14,64 @@ // along with gmnhg. If not, see . // Package gemini provides functions to convert Markdown files to -// Gemtext. +// Gemtext. It supports the use of YAML front matter in Markdown. package gemini import ( + "bytes" + "fmt" + "time" + "git.tdem.in/tdemin/gmnhg/internal/gemini" "github.com/gomarkdown/markdown" "github.com/gomarkdown/markdown/parser" + "gopkg.in/yaml.v2" ) -// RenderMarkdown converts Markdown text to text/gemini using gomarkdown. -// -// gomarkdown doesn't return any errors, nor does this function. -func RenderMarkdown(md []byte) (geminiText []byte) { - ast := markdown.Parse(md, parser.NewWithExtensions(parser.CommonExtensions)) - geminiContent := markdown.Render(ast, gemini.NewRenderer()) - return geminiContent +// hugoMetadata implements gemini.Metadata, providing the bare minimum +// of possible post props. +type hugoMetadata struct { + PostTitle string `yaml:"title"` + PostDate time.Time `yaml:"date"` +} + +func (h hugoMetadata) Title() string { + return h.PostTitle +} + +func (h hugoMetadata) Date() time.Time { + return h.PostDate +} + +var yamlDelimiter = []byte("---\n") + +// RenderMarkdown converts Markdown text to text/gemini using +// gomarkdown, appending Hugo YAML front matter data if any is present +// to the post header. +func RenderMarkdown(md []byte) (geminiText []byte, err error) { + var metadata hugoMetadata + if len(md) > len(yamlDelimiter)*2 { + // only allow front matter at file start + if bytes.Index(md, yamlDelimiter) != 0 { + goto parse + } + blockEnd := bytes.Index(md[len(yamlDelimiter):], yamlDelimiter) + if blockEnd == -1 { + goto parse + } + yamlContent := md[len(yamlDelimiter) : blockEnd+len(yamlDelimiter)] + if err := yaml.Unmarshal(yamlContent, &metadata); err != nil { + return nil, fmt.Errorf("invalid front matter: %w", err) + } + md = md[blockEnd+len(yamlDelimiter)*2:] + } +parse: + ast := markdown.Parse(md, parser.NewWithExtensions(parser.CommonExtensions)) + var geminiContent []byte + if metadata.PostTitle != "" { + geminiContent = markdown.Render(ast, gemini.NewRendererWithMetadata(metadata)) + } else { + geminiContent = markdown.Render(ast, gemini.NewRenderer()) + } + return geminiContent, nil } From ceed6f07f474acfd8e24ae2a3d5389dc759503de Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Tue, 10 Nov 2020 01:12:20 +0500 Subject: [PATCH 05/20] Fix rendering of links as first paragraph child Fixes #2. --- internal/gemini/renderer.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index 5b1792e..a3543d4 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -150,8 +150,8 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) (no // current version of gomarkdown/markdown finds an empty // *ast.Text element before links/images, breaking the heuristic onlyElementWithGoMarkdownFix := func() bool { - if len(node.Children) > 1 { - firstChild := node.Children[0] + if len(children) == 2 { + firstChild := children[0] _, elementIsText := firstChild.(*ast.Text) asLeaf := firstChild.AsLeaf() if elementIsText && asLeaf != nil && len(asLeaf.Literal) == 0 { @@ -163,7 +163,7 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) (no }() onlyElement := len(children) == 1 || onlyElementWithGoMarkdownFix onlyElementIsLink := func() bool { - if len(children) >= 1 { + if len(children) == 1 { if _, ok := children[0].(*ast.Link); ok { return true } From adf921d2a5cbcbcd3c9d9e7486dd965c0209f2f0 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Tue, 10 Nov 2020 01:18:12 +0500 Subject: [PATCH 06/20] Update TODO in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 136a9c7..01332fc 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Usage of md2gmn: ## TODO + [x] convert Markdown text to Gemtext -+ [ ] prepend contents of YAML front matter to Gemtext data ++ [x] prepend contents of YAML front matter to Gemtext data + [ ] render all Hugo content files to Gemtext in accordance with front matter data and Hugo config From 9ea608670fe6a5f5bae1490088983570c9c6bccd Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Tue, 10 Nov 2020 01:18:52 +0500 Subject: [PATCH 07/20] Clarify the subset of front matter data rendered --- render.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/render.go b/render.go index ab1d7f7..9737851 100644 --- a/render.go +++ b/render.go @@ -48,6 +48,9 @@ var yamlDelimiter = []byte("---\n") // RenderMarkdown converts Markdown text to text/gemini using // gomarkdown, appending Hugo YAML front matter data if any is present // to the post header. +// +// Only a subset of front matter data parsed by Hugo is included in the +// final document. At this point it's just title and date. func RenderMarkdown(md []byte) (geminiText []byte, err error) { var metadata hugoMetadata if len(md) > len(yamlDelimiter)*2 { From 637ff4b71b2a118c8458881fa2cf74ed7d089fb6 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Tue, 10 Nov 2020 09:51:03 +0500 Subject: [PATCH 08/20] Rid of an unneeded check RenderMarkdown doesn't really need an extra check on whether or not the Markdown content size is more than a specific amount. --- render.go | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/render.go b/render.go index 9737851..8b320cf 100644 --- a/render.go +++ b/render.go @@ -52,22 +52,24 @@ var yamlDelimiter = []byte("---\n") // Only a subset of front matter data parsed by Hugo is included in the // final document. At this point it's just title and date. func RenderMarkdown(md []byte) (geminiText []byte, err error) { - var metadata hugoMetadata - if len(md) > len(yamlDelimiter)*2 { - // only allow front matter at file start - if bytes.Index(md, yamlDelimiter) != 0 { - goto parse - } - blockEnd := bytes.Index(md[len(yamlDelimiter):], yamlDelimiter) - if blockEnd == -1 { - goto parse - } - yamlContent := md[len(yamlDelimiter) : blockEnd+len(yamlDelimiter)] - if err := yaml.Unmarshal(yamlContent, &metadata); err != nil { - return nil, fmt.Errorf("invalid front matter: %w", err) - } - md = md[blockEnd+len(yamlDelimiter)*2:] + var ( + metadata hugoMetadata + blockEnd int + yamlContent []byte + ) + // only allow front matter at file start + if bytes.Index(md, yamlDelimiter) != 0 { + goto parse } + blockEnd = bytes.Index(md[len(yamlDelimiter):], yamlDelimiter) + if blockEnd == -1 { + goto parse + } + yamlContent = md[len(yamlDelimiter) : blockEnd+len(yamlDelimiter)] + if err := yaml.Unmarshal(yamlContent, &metadata); err != nil { + return nil, fmt.Errorf("invalid front matter: %w", err) + } + md = md[blockEnd+len(yamlDelimiter)*2:] parse: ast := markdown.Parse(md, parser.NewWithExtensions(parser.CommonExtensions)) var geminiContent []byte From 35b41689357b3905de5ede182b92a3b06e05558c Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Tue, 10 Nov 2020 20:15:55 +0500 Subject: [PATCH 09/20] Comply with Gemini spec p. 5.4.1 This part of spec says soft text wrapping is preferred to hard wrapping, to comply with that we replace the newlines in raw Markdown text with spaces. --- internal/gemini/renderer.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index a3543d4..be8ade3 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -22,6 +22,7 @@ import ( "bytes" "fmt" "io" + "strings" "time" "github.com/gomarkdown/markdown/ast" @@ -266,7 +267,9 @@ func (r Renderer) list(w io.Writer, node *ast.List, level int) { func (r Renderer) text(w io.Writer, node ast.Node) { if node := node.AsLeaf(); node != nil { - w.Write(node.Literal) + // replace all newlines in text with spaces, allowing for soft + // wrapping; this is recommended as per Gemini spec p. 5.4.1 + w.Write([]byte(strings.ReplaceAll(string(node.Literal), "\n", " "))) } } From 8226a2088038aebbead09a599fd5cd904281ec71 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Wed, 11 Nov 2020 22:32:26 +0500 Subject: [PATCH 10/20] Change API for simpler use by gmnhg --- cmd/md2gmn/main.go | 2 +- render.go | 36 +++++++++++++++++++++++++----------- 2 files changed, 26 insertions(+), 12 deletions(-) diff --git a/cmd/md2gmn/main.go b/cmd/md2gmn/main.go index 3d7ed9a..8662af5 100644 --- a/cmd/md2gmn/main.go +++ b/cmd/md2gmn/main.go @@ -47,7 +47,7 @@ func main() { panic(err) } - geminiContent, err := gemini.RenderMarkdown(text) + geminiContent, _, err := gemini.RenderMarkdown(text, true) if err != nil { panic(err) } diff --git a/render.go b/render.go index 8b320cf..4de9c80 100644 --- a/render.go +++ b/render.go @@ -19,6 +19,7 @@ package gemini import ( "bytes" + "errors" "fmt" "time" @@ -28,32 +29,42 @@ import ( "gopkg.in/yaml.v2" ) -// hugoMetadata implements gemini.Metadata, providing the bare minimum +// HugoMetadata implements gemini.Metadata, providing the bare minimum // of possible post props. -type hugoMetadata struct { - PostTitle string `yaml:"title"` - PostDate time.Time `yaml:"date"` +type HugoMetadata struct { + PostTitle string `yaml:"title"` + PostIsDraft bool `yaml:"draft"` + PostLayout string `yaml:"layout"` + PostDate time.Time `yaml:"date"` } -func (h hugoMetadata) Title() string { +// Title returns post title. +func (h HugoMetadata) Title() string { return h.PostTitle } -func (h hugoMetadata) Date() time.Time { +// Date returns post date. +func (h HugoMetadata) Date() time.Time { return h.PostDate } var yamlDelimiter = []byte("---\n") +// ErrPostIsDraft indicates the post rendered is a draft and is not +// supposed to be rendered. +var ErrPostIsDraft = errors.New("post is draft") + // RenderMarkdown converts Markdown text to text/gemini using // gomarkdown, appending Hugo YAML front matter data if any is present // to the post header. // // Only a subset of front matter data parsed by Hugo is included in the // final document. At this point it's just title and date. -func RenderMarkdown(md []byte) (geminiText []byte, err error) { +// +// Draft posts are still rendered, but with an error of type +// ErrPostIsDraft. +func RenderMarkdown(md []byte, withMetadata bool) (geminiText []byte, metadata HugoMetadata, err error) { var ( - metadata hugoMetadata blockEnd int yamlContent []byte ) @@ -67,16 +78,19 @@ func RenderMarkdown(md []byte) (geminiText []byte, err error) { } yamlContent = md[len(yamlDelimiter) : blockEnd+len(yamlDelimiter)] if err := yaml.Unmarshal(yamlContent, &metadata); err != nil { - return nil, fmt.Errorf("invalid front matter: %w", err) + return nil, metadata, fmt.Errorf("invalid front matter: %w", err) } md = md[blockEnd+len(yamlDelimiter)*2:] parse: ast := markdown.Parse(md, parser.NewWithExtensions(parser.CommonExtensions)) var geminiContent []byte - if metadata.PostTitle != "" { + if withMetadata && metadata.PostTitle != "" { geminiContent = markdown.Render(ast, gemini.NewRendererWithMetadata(metadata)) } else { geminiContent = markdown.Render(ast, gemini.NewRenderer()) } - return geminiContent, nil + if metadata.PostIsDraft { + return geminiContent, metadata, fmt.Errorf("%s: %w", metadata.PostTitle, ErrPostIsDraft) + } + return geminiContent, metadata, nil } From 1a0e61dc3fb1ab46c81dfbb871be975a7f525547 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Wed, 11 Nov 2020 23:15:26 +0500 Subject: [PATCH 11/20] Implement gmnhg gmnhg is the new program that generates a Gemini site from Hugo site content. It reads its input from content/, static/, and layouts/gmnhg/. Its output by default goes to output/. More doc is available in the program doc header. --- cmd/gmnhg/main.go | 290 ++++++++++++++++++++++++++++++++++++++++- cmd/gmnhg/templates.go | 65 +++++++++ cmd/md2gmn/main.go | 2 +- render.go | 15 ++- 4 files changed, 365 insertions(+), 7 deletions(-) create mode 100644 cmd/gmnhg/templates.go diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index 67fb969..d06e8e7 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -1,8 +1,290 @@ -// gmnhg converts Hugo posts to gemini content. +// This file is part of gmnhg. + +// gmnhg 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. + +// gmnhg 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 gmnhg. If not, see . + +// gmnhg converts Hugo content files to a Gemini site. This program is +// to be started in the top level directory of a Hugo site (the one +// containing config.toml). // -// TODO: it is yet to actually do that. +// gmngh will read layout template files (with .gotmpl extension) and +// then apply them to content files ending with .md by the following +// algorithm (file names are relative to layouts/gmnhg): +// +// 1. If the .md file specifies its own layout, the relevant layout file +// is applied. If not, the default template is applied (single). If the +// layout file does not exist, the file is skipped. Draft posts are not +// rendered. _index.md files are also skipped. +// +// 2. For every top-level content directory an index.gmi is generated, +// the corresponding template is taken from top/{directory_name}.gotmpl. +// If there's no matching template, the index won't be rendered. +// +// 3. The very top index.gmi is generated from index.gotmpl. +// +// The program will then copy static files from static/ directory to the +// output dir. +// +// Templates are passed the following data: +// +// 1. Single pages are given .Post, which contains the entire post +// rendered, .Metadata, which contains the metadata crawled from it (see +// HugoMetadata), and .Link, which contains the filename relative to +// content dir (with .md replaced with .gmi). +// +// 2. Directory index pages are passed .Posts, which is a slice over +// post metadata crawled (see HugoMetadata), and .Dirname, which is +// directory name relative to content dir. +// +// 3. The top-level index.gmi is passed with the .PostData map whose +// keys are top-level content directories names and values are slices +// over the same post props as specified in 1. +// +// This program provides some extra template functions, documented in +// templates.go. package main -func main() { - println("in development") +import ( + "bytes" + "flag" + "io" + "io/ioutil" + "os" + "path" + "path/filepath" + "regexp" + "strings" + "text/template" + + gemini "git.tdem.in/tdemin/gmnhg" +) + +const defaultTemplate = "single" + +const ( + contentBase = "content/" + templateBase = "layouts/gmnhg/" + staticBase = "static/" + outputBase = "output/" +) + +var ( + tmplNameRegex = regexp.MustCompile(templateBase + `(\w+)\.gotmpl`) + contentNameRegex = regexp.MustCompile(contentBase + `([\w-_ ]+)\.md`) + topLevelPostRegex = regexp.MustCompile(contentBase + `([\w-_ ]+)/([\w-_ ]+)\.md`) +) + +// TODO: more meaningful errors + +type post struct { + Post []byte + Metadata gemini.HugoMetadata + Link string +} + +func copyFile(dst, src string) error { + input, err := os.Open(src) + if err != nil { + return err + } + defer input.Close() + if p := path.Dir(dst); p != "" { + if err := os.MkdirAll(p, 0755); err != nil { + return err + } + } + output, err := os.Create(dst) + if err != nil { + return err + } + defer output.Close() + if _, err := io.Copy(output, input); err != nil { + return err + } + return nil +} + +func writeFile(dst string, contents []byte) error { + if p := path.Dir(dst); p != "" { + if err := os.MkdirAll(p, 0755); err != nil { + return err + } + } + output, err := os.Create(dst) + if err != nil { + return err + } + defer output.Close() + if _, err := output.Write(contents); err != nil { + return err + } + return nil +} + +func main() { + var outputDir, workingDir string + flag.StringVar(&outputDir, "output", outputBase, "output directory (will be created if missing)") + flag.StringVar(&workingDir, "working", "", "working directory (defaults to current directory)") + flag.Parse() + + if workingDir != "" { + if err := os.Chdir(workingDir); err != nil { + panic(err) + } + } + + if fileInfo, err := os.Stat("config.toml"); os.IsNotExist(err) || fileInfo.IsDir() { + panic("config.toml either doesn't exist or is a directory; not in a Hugo site dir?") + } + + // build templates + templates := make(map[string]*template.Template) + if _, err := os.Stat(templateBase); !os.IsNotExist(err) { + if err := filepath.Walk(templateBase, func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + if info.IsDir() { + return nil + } + name := tmplNameRegex.FindStringSubmatch(path) + if name == nil || len(name) != 2 { + return nil + } + tmplName := name[1] + contents, err := ioutil.ReadFile(path) + if err != nil { + return err + } + tmpl, err := template.New(tmplName).Funcs(funcMap).Parse(string(contents)) + if err != nil { + return err + } + templates[tmplName] = tmpl + return nil + }); err != nil { + panic(err) + } + } + + // render posts to Gemtext and collect top level posts data + posts := make(map[string]*post, 0) + topLevelPosts := make(map[string][]*post) + if err := filepath.Walk(contentBase, func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + if n := info.Name(); info.IsDir() || !strings.HasSuffix(n, ".md") || n == "_index.md" { + return nil + } + fileContent, err := ioutil.ReadFile(path) + if err != nil { + return err + } + gemText, metadata, err := gemini.RenderMarkdown(fileContent, gemini.WithoutMetadata) + if err != nil { + return err + } + // skip drafts from rendering + if metadata.PostIsDraft { + return nil + } + key := strings.TrimPrefix(strings.TrimSuffix(path, ".md"), contentBase) + ".gmi" + p := post{ + Post: gemText, + Link: key, + Metadata: metadata, + } + posts[key] = &p + if matches := topLevelPostRegex.FindStringSubmatch(path); matches != nil { + topLevelPosts[matches[1]] = append(topLevelPosts[matches[1]], &p) + } + return nil + }); err != nil { + panic(err) + } + + // clean up output dir beforehand + if _, err := os.Stat(outputDir); os.IsNotExist(err) { + if err := os.MkdirAll(outputDir, 0755); err != nil { + panic(err) + } + } else { + dir, err := ioutil.ReadDir(outputDir) + if err != nil { + panic(err) + } + for _, d := range dir { + os.RemoveAll(path.Join(outputDir, d.Name())) + } + } + + // render posts to files + for fileName, post := range posts { + var tmpl = defaultSingleTemplate + if pl := post.Metadata.PostLayout; pl != "" { + t, ok := templates[pl] + if !ok { + // no point trying to render pages with no layout + continue + } + tmpl = t + } + buf := bytes.Buffer{} + if err := tmpl.Execute(&buf, &post); err != nil { + panic(err) + } + if err := writeFile(path.Join(outputDir, fileName), buf.Bytes()); err != nil { + panic(err) + } + } + // render indexes for top-level dirs + for dirname, posts := range topLevelPosts { + tmpl, hasTmpl := templates["top/"+dirname] + if !hasTmpl { + continue + } + buf := bytes.Buffer{} + if err := tmpl.Execute(&buf, map[string]interface{}{ + "Posts": posts, + "Dirname": dirname, + }); err != nil { + panic(err) + } + if err := writeFile(path.Join(outputDir, dirname, "index.gmi"), buf.Bytes()); err != nil { + panic(err) + } + } + // render index page + var indexTmpl = defaultIndexTemplate + if t, hasIndexTmpl := templates["index"]; hasIndexTmpl { + indexTmpl = t + } + buf := bytes.Buffer{} + if err := indexTmpl.Execute(&buf, map[string]interface{}{"PostData": topLevelPosts}); err != nil { + panic(err) + } + if err := writeFile(path.Join(outputDir, "index.gmi"), buf.Bytes()); err != nil { + panic(err) + } + + // copy static files to output dir unmodified + if err := filepath.Walk(staticBase, func(p string, info os.FileInfo, err error) error { + if info.IsDir() { + return nil + } + return copyFile(path.Join(outputDir, strings.TrimPrefix(p, staticBase)), p) + }); err != nil { + panic(err) + } } diff --git a/cmd/gmnhg/templates.go b/cmd/gmnhg/templates.go new file mode 100644 index 0000000..105b4b5 --- /dev/null +++ b/cmd/gmnhg/templates.go @@ -0,0 +1,65 @@ +// This file is part of gmnhg. + +// gmnhg 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. + +// gmnhg 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 gmnhg. If not, see . + +package main + +import ( + "sort" + "text/template" +) + +type postsSort []*post + +func (p postsSort) Len() int { + return len(p) +} + +func (p postsSort) Less(i, j int) bool { + return p[i].Metadata.PostDate.After(p[j].Metadata.PostDate) +} + +func (p postsSort) Swap(i, j int) { + t := p[i] + p[i] = p[j] + p[j] = t +} + +func mustParseTmpl(name, value string) *template.Template { + return template.Must(template.New(name).Funcs(funcMap).Parse(value)) +} + +var funcMap template.FuncMap = template.FuncMap{ + // sorts posts by date, newest posts go first + "sortPosts": func(posts []*post) []*post { + ps := make(postsSort, len(posts)) + copy(ps, posts) + sort.Sort(ps) + return ps + }, +} + +var defaultSingleTemplate = mustParseTmpl("single", `# {{ .Metadata.PostTitle }} + +{{ .Metadata.PostDate.Format "2006-01-02 15:04" }} + +{{ printf "%s" .Post }}`) + +var defaultIndexTemplate = mustParseTmpl("index", `# Site index + +{{ range $dir, $posts := .PostData }}Index of {{ $dir }}: + +{{ range $p := $posts | sortPosts }}=> {{ $p.Link }} {{ $p.Metadata.PostDate.Format "2006-01-02 15:04" }} - {{ $p.Metadata.PostTitle }} +{{ end }}{{ end }} +`) diff --git a/cmd/md2gmn/main.go b/cmd/md2gmn/main.go index 8662af5..f5b26b3 100644 --- a/cmd/md2gmn/main.go +++ b/cmd/md2gmn/main.go @@ -47,7 +47,7 @@ func main() { panic(err) } - geminiContent, _, err := gemini.RenderMarkdown(text, true) + geminiContent, _, err := gemini.RenderMarkdown(text, gemini.WithMetadata) if err != nil { panic(err) } diff --git a/render.go b/render.go index 4de9c80..bd07869 100644 --- a/render.go +++ b/render.go @@ -54,6 +54,17 @@ var yamlDelimiter = []byte("---\n") // supposed to be rendered. var ErrPostIsDraft = errors.New("post is draft") +// MetadataSetting defines whether or not metadata is included in the +// rendered text. +type MetadataSetting int + +// Metadata settings control the inclusion of metadata in the rendered +// text. +const ( + WithMetadata MetadataSetting = iota + WithoutMetadata +) + // RenderMarkdown converts Markdown text to text/gemini using // gomarkdown, appending Hugo YAML front matter data if any is present // to the post header. @@ -63,7 +74,7 @@ var ErrPostIsDraft = errors.New("post is draft") // // Draft posts are still rendered, but with an error of type // ErrPostIsDraft. -func RenderMarkdown(md []byte, withMetadata bool) (geminiText []byte, metadata HugoMetadata, err error) { +func RenderMarkdown(md []byte, metadataSetting MetadataSetting) (geminiText []byte, metadata HugoMetadata, err error) { var ( blockEnd int yamlContent []byte @@ -84,7 +95,7 @@ func RenderMarkdown(md []byte, withMetadata bool) (geminiText []byte, metadata H parse: ast := markdown.Parse(md, parser.NewWithExtensions(parser.CommonExtensions)) var geminiContent []byte - if withMetadata && metadata.PostTitle != "" { + if metadataSetting == WithMetadata && metadata.PostTitle != "" { geminiContent = markdown.Render(ast, gemini.NewRendererWithMetadata(metadata)) } else { geminiContent = markdown.Render(ast, gemini.NewRenderer()) From 8c1a9a36daa0ddeeab692bb1009b72ae35a71fbd Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Thu, 19 Nov 2020 03:09:28 +0500 Subject: [PATCH 12/20] Refactor rendering code This refactoring simplifies some originally quirky parts of rendering code while also adding support for rendering emphasized text (handled by the same routine the ordinary text already is). --- internal/gemini/renderer.go | 83 +++++++++---------------------------- 1 file changed, 19 insertions(+), 64 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index be8ade3..9073d97 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -18,8 +18,6 @@ package gemini import ( - "bufio" - "bytes" "fmt" "io" "strings" @@ -65,30 +63,8 @@ func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { if entering { w.Write(linkPrefix) w.Write(node.Destination) - for _, child := range node.Children { - if l := child.AsLeaf(); l != nil { - w.Write(space) - w.Write(l.Literal) - } - } - } -} - -func (r Renderer) linkText(w io.Writer, node *ast.Link) { - for _, text := range node.Children { - // TODO: Renderer.linkText: link can contain subblocks - if l := text.AsLeaf(); l != nil { - w.Write(l.Literal) - } - } -} - -func (r Renderer) imageText(w io.Writer, node *ast.Image) { - for _, text := range node.Children { - // TODO: Renderer.imageText: link can contain subblocks - if l := text.AsLeaf(); l != nil { - w.Write(l.Literal) - } + w.Write(space) + r.text(w, node) } } @@ -96,15 +72,8 @@ func (r Renderer) image(w io.Writer, node *ast.Image, entering bool) { if entering { w.Write(linkPrefix) w.Write(node.Destination) - for _, sub := range node.Container.Children { - if l := sub.AsLeaf(); l != nil { - // TODO: Renderer.image: Markdown technically allows for - // links inside image titles, yet to think out how to - // render that :thinking: - w.Write(space) - w.Write(l.Literal) - } - } + w.Write(space) + r.text(w, node) } } @@ -113,16 +82,8 @@ func (r Renderer) blockquote(w io.Writer, node *ast.BlockQuote, entering bool) { // ideally to be merged with paragraph if entering { if para, ok := node.Children[0].(*ast.Paragraph); ok { - for _, subnode := range para.Children { - if l := subnode.AsLeaf(); l != nil { - reader := bufio.NewScanner(bytes.NewBuffer(l.Literal)) - for reader.Scan() { - w.Write(quotePrefix) - w.Write(reader.Bytes()) - w.Write(lineBreak) - } - } - } + w.Write(quotePrefix) + r.text(w, para) } } } @@ -178,23 +139,14 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) (no for _, child := range children { // only render links text in the paragraph if they're // combined with some other text on page - if link, ok := child.(*ast.Link); ok { + switch child := child.(type) { + case *ast.Link, *ast.Image: if !onlyElement { - r.linkText(w, link) + r.text(w, child) } - linkStack = append(linkStack, link) - } - if image, ok := child.(*ast.Image); ok { - if !onlyElement { - r.imageText(w, image) - } - linkStack = append(linkStack, image) - } - if text, ok := child.(*ast.Text); ok { - r.text(w, text) - } - if inlineBlock, ok := child.(*ast.Code); ok { - r.text(w, inlineBlock) + linkStack = append(linkStack, child) + case *ast.Text, *ast.Code, *ast.Emph, *ast.Strong, *ast.Del: + r.text(w, child) } } if !onlyElementIsLink { @@ -250,10 +202,7 @@ func (r Renderer) list(w io.Writer, node *ast.List, level int) { } para, ok := item.Children[0].(*ast.Paragraph) if ok { - text, ok := para.Children[0].(*ast.Text) - if ok { - r.text(w, text) - } + r.text(w, para) } w.Write(lineBreak) if l >= 2 { @@ -270,6 +219,12 @@ func (r Renderer) text(w io.Writer, node ast.Node) { // replace all newlines in text with spaces, allowing for soft // wrapping; this is recommended as per Gemini spec p. 5.4.1 w.Write([]byte(strings.ReplaceAll(string(node.Literal), "\n", " "))) + return + } + if node := node.AsContainer(); node != nil { + for _, child := range node.Children { + r.text(w, child) + } } } From b660e0b1da1488072fcba068b70b8f329a4df78d Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Thu, 19 Nov 2020 03:27:03 +0500 Subject: [PATCH 13/20] Rewrite README with info on gmnhg --- README.md | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 01332fc..c7650a5 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,6 @@ simpler. [Gemini]: https://gemini.circumlunar.space [Gemtext]: https://gemini.circumlunar.space/docs/specification.html -At this stage of development this repo contains the actual renderer -(`internal/gemini`) and the `md2gmn` program that converts Markdown -input to Gemtext and is supposed to facilitate testing. - The renderer is somewhat hasty, and is NOT supposed to be able to convert the entirety of possible Markdown to Gemtext (as it's not possible to do so, considering Gemtext is a lot simpler than Markdown), @@ -20,10 +16,28 @@ but instead a selected subset of it, enough for conveying your mind in Markdown. The renderer uses the [gomarkdown][gomarkdown] library for parsing -Markdown. +Markdown. gomarkdown has a few quirks at this time, the most notable one +being unable to parse links/images inside other links. [gomarkdown]: https://github.com/gomarkdown/markdown +## gmnhg + +This program converts Hugo Markdown content files from `content/` in +accordance with templates found in `layouts/gmnhg` to the output dir. It +also copies static files from `static/` to the output dir. + +For more details about the rendering process, see the +[doc](cmd/gmnhg/main.go) attached to the program. + +``` +Usage of gmnhg: + -output string + output directory (will be created if missing) (default "output/") + -working string + working directory (defaults to current directory) +``` + ## md2gmn This program reads Markdown input from either text file (if `-f @@ -35,15 +49,11 @@ Usage of md2gmn: input file ``` -## TODO - -+ [x] convert Markdown text to Gemtext -+ [x] prepend contents of YAML front matter to Gemtext data -+ [ ] render all Hugo content files to Gemtext in accordance with front - matter data and Hugo config +md2gmn is mainly made to facilitate testing the Gemtext renderer but +can be used as a standalone program as well. ## License This program is redistributed under the terms and conditions of the GNU -General Public License, more specifically under version 3 of the -License. For details, see [COPYING](COPYING). +General Public License, more specifically version 3 of the License. For +details, see [COPYING](COPYING). From 6859f3d57c97cc0abdd80cc315d28f5097e48529 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Thu, 19 Nov 2020 03:32:55 +0500 Subject: [PATCH 14/20] Fix panic on draft posts --- cmd/gmnhg/main.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index d06e8e7..dede3d0 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -56,6 +56,7 @@ package main import ( "bytes" + "errors" "flag" "io" "io/ioutil" @@ -192,12 +193,11 @@ func main() { return err } gemText, metadata, err := gemini.RenderMarkdown(fileContent, gemini.WithoutMetadata) - if err != nil { - return err - } // skip drafts from rendering - if metadata.PostIsDraft { + if errors.Is(err, gemini.ErrPostIsDraft) { return nil + } else if err != nil { + return err } key := strings.TrimPrefix(strings.TrimSuffix(path, ".md"), contentBase) + ".gmi" p := post{ From 0a62f8142cadc49764ccc790866ea5053c576ece Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Thu, 19 Nov 2020 04:30:37 +0500 Subject: [PATCH 15/20] Fix single template not being sourced --- cmd/gmnhg/main.go | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index dede3d0..200f6a7 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -229,9 +229,14 @@ func main() { } } + var singleTemplate = defaultSingleTemplate + if tmpl, hasTmpl := templates["single"]; hasTmpl { + singleTemplate = tmpl + } + // render posts to files for fileName, post := range posts { - var tmpl = defaultSingleTemplate + var tmpl = singleTemplate if pl := post.Metadata.PostLayout; pl != "" { t, ok := templates[pl] if !ok { From 9d1637248777a3b2aff5ff5ff526d35f0284f947 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Thu, 19 Nov 2020 21:12:59 +0500 Subject: [PATCH 16/20] Implement sourcing _index.md content Fixes #5. The Markdown content is sourced from _index.gmi.md so we don't interfere with native Web content. --- cmd/gmnhg/main.go | 69 +++++++++++++++++++++++++++++++----------- cmd/gmnhg/templates.go | 1 + 2 files changed, 53 insertions(+), 17 deletions(-) diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index 200f6a7..22a5fb3 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -19,7 +19,7 @@ // // gmngh will read layout template files (with .gotmpl extension) and // then apply them to content files ending with .md by the following -// algorithm (file names are relative to layouts/gmnhg): +// algorithm (layout file names are relative to layouts/gmnhg): // // 1. If the .md file specifies its own layout, the relevant layout file // is applied. If not, the default template is applied (single). If the @@ -28,9 +28,11 @@ // // 2. For every top-level content directory an index.gmi is generated, // the corresponding template is taken from top/{directory_name}.gotmpl. -// If there's no matching template, the index won't be rendered. +// Its content is taken from _index.gmi.md in that dir. If there's no +// matching template or no _index.gmi.md, the index won't be rendered. // -// 3. The very top index.gmi is generated from index.gotmpl. +// 3. The very top index.gmi is generated from index.gotmpl and +// top-level _index.gmi. // // The program will then copy static files from static/ directory to the // output dir. @@ -43,15 +45,22 @@ // content dir (with .md replaced with .gmi). // // 2. Directory index pages are passed .Posts, which is a slice over -// post metadata crawled (see HugoMetadata), and .Dirname, which is -// directory name relative to content dir. +// post metadata crawled (see HugoMetadata), .Dirname, which is +// directory name relative to content dir, and .Content, which is +// rendered from directory's _index.gmi.md. // // 3. The top-level index.gmi is passed with the .PostData map whose // keys are top-level content directories names and values are slices -// over the same post props as specified in 1. +// over the same post props as specified in 1, and .Content, which is +// rendered from top-level _index.gmi.md. // // This program provides some extra template functions, documented in // templates.go. +// +// One might want to ignore _index.gmi.md files with the following Hugo +// config option in config.toml: +// +// ignoreFiles = [ "_index\\.gmi\\.md$" ] package main import ( @@ -70,7 +79,11 @@ import ( gemini "git.tdem.in/tdemin/gmnhg" ) -const defaultTemplate = "single" +const ( + defaultTemplate = "single" + indexMdFilename = "_index.gmi.md" + indexFilename = "index.gmi" +) const ( contentBase = "content/" @@ -80,7 +93,7 @@ const ( ) var ( - tmplNameRegex = regexp.MustCompile(templateBase + `(\w+)\.gotmpl`) + tmplNameRegex = regexp.MustCompile(templateBase + `([\w-_ /]+)\.gotmpl`) contentNameRegex = regexp.MustCompile(contentBase + `([\w-_ ]+)\.md`) topLevelPostRegex = regexp.MustCompile(contentBase + `([\w-_ ]+)/([\w-_ ]+)\.md`) ) @@ -259,14 +272,27 @@ func main() { if !hasTmpl { continue } - buf := bytes.Buffer{} - if err := tmpl.Execute(&buf, map[string]interface{}{ - "Posts": posts, - "Dirname": dirname, - }); err != nil { + content, err := ioutil.ReadFile(path.Join(contentBase, dirname, indexMdFilename)) + if err != nil { + // skip unreadable index files + continue + } + gemtext, _, err := gemini.RenderMarkdown(content, gemini.WithoutMetadata) + if errors.Is(err, gemini.ErrPostIsDraft) { + continue + } else if err != nil { panic(err) } - if err := writeFile(path.Join(outputDir, dirname, "index.gmi"), buf.Bytes()); err != nil { + cnt := map[string]interface{}{ + "Posts": posts, + "Dirname": dirname, + "Content": gemtext, + } + buf := bytes.Buffer{} + if err := tmpl.Execute(&buf, cnt); err != nil { + panic(err) + } + if err := writeFile(path.Join(outputDir, dirname, indexFilename), buf.Bytes()); err != nil { panic(err) } } @@ -275,11 +301,20 @@ func main() { if t, hasIndexTmpl := templates["index"]; hasIndexTmpl { indexTmpl = t } - buf := bytes.Buffer{} - if err := indexTmpl.Execute(&buf, map[string]interface{}{"PostData": topLevelPosts}); err != nil { + indexContent, err := ioutil.ReadFile(path.Join(contentBase, indexMdFilename)) + if err != nil { panic(err) } - if err := writeFile(path.Join(outputDir, "index.gmi"), buf.Bytes()); err != nil { + gemtext, _, err := gemini.RenderMarkdown(indexContent, gemini.WithoutMetadata) + if err != nil && !errors.Is(err, gemini.ErrPostIsDraft) { + panic(err) + } + buf := bytes.Buffer{} + cnt := map[string]interface{}{"PostData": topLevelPosts, "Content": gemtext} + if err := indexTmpl.Execute(&buf, cnt); err != nil { + panic(err) + } + if err := writeFile(path.Join(outputDir, indexFilename), buf.Bytes()); err != nil { panic(err) } diff --git a/cmd/gmnhg/templates.go b/cmd/gmnhg/templates.go index 105b4b5..050cb6b 100644 --- a/cmd/gmnhg/templates.go +++ b/cmd/gmnhg/templates.go @@ -58,6 +58,7 @@ var defaultSingleTemplate = mustParseTmpl("single", `# {{ .Metadata.PostTitle }} var defaultIndexTemplate = mustParseTmpl("index", `# Site index +{{ with .Content }}{{ printf "%s" . -}}{{ end }} {{ range $dir, $posts := .PostData }}Index of {{ $dir }}: {{ range $p := $posts | sortPosts }}=> {{ $p.Link }} {{ $p.Metadata.PostDate.Format "2006-01-02 15:04" }} - {{ $p.Metadata.PostTitle }} From 421a40783c6a034649efbb908493ec0f3729970f Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Thu, 19 Nov 2020 21:16:36 +0500 Subject: [PATCH 17/20] Use gmnhg/ instead of layouts/gmnhg/ Unfortunately, Hugo will try to parse every template file in layouts/, so we have to reside somewhere else. --- README.md | 2 +- cmd/gmnhg/main.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c7650a5..44cc4be 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ being unable to parse links/images inside other links. ## gmnhg This program converts Hugo Markdown content files from `content/` in -accordance with templates found in `layouts/gmnhg` to the output dir. It +accordance with templates found in `gmnhg/` to the output dir. It also copies static files from `static/` to the output dir. For more details about the rendering process, see the diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index 22a5fb3..8a5d82f 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -19,7 +19,7 @@ // // gmngh will read layout template files (with .gotmpl extension) and // then apply them to content files ending with .md by the following -// algorithm (layout file names are relative to layouts/gmnhg): +// algorithm (layout file names are relative to gmnhg/): // // 1. If the .md file specifies its own layout, the relevant layout file // is applied. If not, the default template is applied (single). If the @@ -87,7 +87,7 @@ const ( const ( contentBase = "content/" - templateBase = "layouts/gmnhg/" + templateBase = "gmnhg/" staticBase = "static/" outputBase = "output/" ) From 1f5257ac90943d92f423f0cbe169f78d3aa3a8f6 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Fri, 20 Nov 2020 03:59:45 +0500 Subject: [PATCH 18/20] Fix rendering of links-only paragraphs --- internal/gemini/renderer.go | 58 ++++++++++++++++++++++--------------- 1 file changed, 34 insertions(+), 24 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index 9073d97..4731475 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -20,6 +20,7 @@ package gemini import ( "fmt" "io" + "regexp" "strings" "time" @@ -35,6 +36,8 @@ var ( itemIndent = []byte{'\t'} ) +var meaningfulCharsRegex = regexp.MustCompile(`\A[\s]+\z`) + const timestampFormat = "2006-01-02 15:04" // Metadata provides data necessary for proper post rendering. @@ -111,50 +114,57 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) (no linkStack := make([]ast.Node, 0, len(children)) // current version of gomarkdown/markdown finds an empty // *ast.Text element before links/images, breaking the heuristic - onlyElementWithGoMarkdownFix := func() bool { - if len(children) == 2 { - firstChild := children[0] - _, elementIsText := firstChild.(*ast.Text) - asLeaf := firstChild.AsLeaf() - if elementIsText && asLeaf != nil && len(asLeaf.Literal) == 0 { - children = children[1:] - return true - } + if len(children) >= 2 { + firstChild := children[0] + _, elementIsText := firstChild.(*ast.Text) + asLeaf := firstChild.AsLeaf() + if elementIsText && asLeaf != nil && len(asLeaf.Literal) == 0 { + children = children[1:] } - return false - }() - onlyElement := len(children) == 1 || onlyElementWithGoMarkdownFix - onlyElementIsLink := func() bool { - if len(children) == 1 { - if _, ok := children[0].(*ast.Link); ok { - return true + } + linksOnly := func() bool { + for _, child := range children { + if _, ok := child.(*ast.Link); ok { + continue } - if _, ok := children[0].(*ast.Image); ok { - return true + if _, ok := child.(*ast.Image); ok { + continue } + if child, ok := child.(*ast.Text); ok { + // any meaningful text? + if meaningfulCharsRegex.Find(child.Literal) == nil { + return false + } + continue + } + return false } - return false + return true }() - noNewLine = onlyElementIsLink + noNewLine = linksOnly for _, child := range children { // only render links text in the paragraph if they're // combined with some other text on page switch child := child.(type) { case *ast.Link, *ast.Image: - if !onlyElement { + if !linksOnly { r.text(w, child) } linkStack = append(linkStack, child) case *ast.Text, *ast.Code, *ast.Emph, *ast.Strong, *ast.Del: - r.text(w, child) + // the condition prevents text blocks consisting only of + // line breaks and spaces and such from rendering + if !linksOnly { + r.text(w, child) + } } } - if !onlyElementIsLink { + if !linksOnly { w.Write(lineBreak) } // render a links block after paragraph if len(linkStack) > 0 { - if !onlyElementIsLink { + if !linksOnly { w.Write(lineBreak) } for _, link := range linkStack { From 2211c5ffdd49836212842e2e0e1d55d2ee4d8086 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Fri, 20 Nov 2020 04:17:20 +0500 Subject: [PATCH 19/20] Prevent rendering _index.gmi.md as posts --- cmd/gmnhg/main.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index 8a5d82f..0f51589 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -198,7 +198,7 @@ func main() { if err != nil { return err } - if n := info.Name(); info.IsDir() || !strings.HasSuffix(n, ".md") || n == "_index.md" { + if n := info.Name(); info.IsDir() || !strings.HasSuffix(n, ".md") || n == "_index.md" || n == indexMdFilename { return nil } fileContent, err := ioutil.ReadFile(path) From 2d55d4f1e6ffa8417f47b486ea0a6dda74bec65c Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Fri, 20 Nov 2020 16:19:01 +0500 Subject: [PATCH 20/20] Add CI config and pkg.go.dev link --- .drone.yml | 27 ++++++++++++++++++++++++++ .goreleaser.yml | 51 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 3 files changed, 80 insertions(+) create mode 100644 .drone.yml create mode 100644 .goreleaser.yml diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000..a7ce8d7 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,27 @@ +kind: pipeline +name: build & release + +steps: +- name: fetch tags + image: docker:git + commands: + - git fetch --tags + when: + event: tag +- name: test + image: golang:1.14 + commands: + - go test -v ./internal/gemini + when: + event: + exclude: + - tag +- name: release + image: golang:1.15 + environment: + GITEA_TOKEN: + from_secret: goreleaser_gitea_token + commands: + - curl -sL https://git.io/goreleaser | bash + when: + event: tag diff --git a/.goreleaser.yml b/.goreleaser.yml new file mode 100644 index 0000000..3060979 --- /dev/null +++ b/.goreleaser.yml @@ -0,0 +1,51 @@ +builds: +- main: ./cmd/gmnhg + id: gmnhg + env: + - CGO_ENABLED=0 + goos: + - linux + - windows + - darwin + - freebsd + - openbsd + - netbsd +- main: ./cmd/md2gmn + id: md2gmn + env: + - CGO_ENABLED=0 + goos: + - linux + - windows + - darwin + - freebsd + - openbsd + - netbsd +archives: +- replacements: + darwin: Darwin + linux: Linux + windows: Windows + freebsd: FreeBSD + openbsd: OpenBSD + netbsd: NetBSD + 386: i386 + amd64: x86_64 +checksum: + name_template: 'checksums.txt' +snapshot: + name_template: "{{ .Tag }}-next" +changelog: + sort: asc + filters: + exclude: + - '^docs:' + - '^test:' + +release: + gitea: + owner: tdemin + name: gmnhg + +gitea_urls: + api: https://git.tdem.in/api/v1/ diff --git a/README.md b/README.md index 44cc4be..cba9b90 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Hugo-to-Gemini converter +[![PkgGoDev](https://pkg.go.dev/badge/git.tdem.in/tdemin/gmnhg)](https://pkg.go.dev/git.tdem.in/tdemin/gmnhg) + This repo holds a converter of Hugo Markdown posts to [text/gemini][Gemtext] (also named Gemtext in this README). The converter is supposed to make people using [Hugo](https://gohugo.io)'s