From f77bdd6b03f16cb8e24d12caf35aed6237678150 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Fri, 6 Nov 2020 13:46:25 +0500 Subject: [PATCH 01/13] Add spew --- go.mod | 5 ++++- go.sum | 2 ++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 8f09c36..17174ca 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/davecgh/go-spew v1.1.1 + github.com/gomarkdown/markdown v0.0.0-20201024011455-45c732cc8a6b +) diff --git a/go.sum b/go.sum index 6b74de0..88392a2 100644 --- a/go.sum +++ b/go.sum @@ -1,3 +1,5 @@ +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= From ff6ab83130c66880398e5a0fc799dd44b9dae562 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Fri, 6 Nov 2020 13:46:40 +0500 Subject: [PATCH 02/13] Add gigignore --- .gitignore | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..66fd13c --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ From 85b0ef51b3796e6e898a6331fe6a9f18de69b6bb Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Fri, 6 Nov 2020 13:47:02 +0500 Subject: [PATCH 03/13] Add the latest code --- cmd/gmnhg/main.go | 41 ++++++++++ internal/gemini/renderer.go | 156 ++++++++++++++++++++++++++++++++++++ 2 files changed, 197 insertions(+) create mode 100644 cmd/gmnhg/main.go create mode 100644 internal/gemini/renderer.go diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go new file mode 100644 index 0000000..9b6c092 --- /dev/null +++ b/cmd/gmnhg/main.go @@ -0,0 +1,41 @@ +// gmnhg converts Hugo posts to gemini content. +// +// 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 more plain text. More of it! + +## Subheading 2 + +More text here. + +## Subheading 3 + +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\n---\ngemini:\n---\n%s\n", text, geminiContent) +} diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go new file mode 100644 index 0000000..dab3094 --- /dev/null +++ b/internal/gemini/renderer.go @@ -0,0 +1,156 @@ +// Package gemini contains an implementation of markdown => text/gemini +// renderer for github.com/gomarkdown/markdown. +package gemini + +import ( + "io" + + "github.com/gomarkdown/markdown/ast" +) + +var ( + lineBreak = []byte{'\n'} + space = []byte{' '} + linkPrefix = []byte("=> ") +) + +// Renderer implements markdown.Renderer. +type Renderer struct { + LinkStack []ast.Node +} + +// NewRenderer returns a new Renderer. +func NewRenderer() Renderer { + return Renderer{ + LinkStack: nil, + } +} + +func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { + if entering { + w.Write(linkPrefix) + w.Write(node.Destination) + if node.Title != nil { + w.Write(space) + w.Write(node.Title) + } + } +} + +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) + } + } + } +} + +func (r Renderer) citation(w io.Writer, node *ast.Citation) {} + +func (r Renderer) heading(w io.Writer, node *ast.Heading, entering bool) { + if entering { + // prepend headings with the relevant number of #-s + heading := make([]byte, node.Level+1) + heading[len(heading)-1] = ' ' + for i := 0; i < len(heading)-1; i++ { + heading[i] = '#' + } + w.Write(heading) + for _, text := range node.Children { + w.Write(text.AsLeaf().Literal) + } + } else { + w.Write(lineBreak) + w.Write(lineBreak) + } +} + +func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { + if entering { + if r.LinkStack != nil { + panic("link stack not empty") + } + r.LinkStack = make([]ast.Node, 0, len(node.Children)) + for _, child := range node.Children { + if link, ok := child.(*ast.Link); ok { + r.LinkStack = append(r.LinkStack, link) + } + if image, ok := child.(*ast.Image); ok { + r.LinkStack = append(r.LinkStack, image) + } + if text, ok := child.(*ast.Text); ok { + r.text(w, text) + } + } + } else { + w.Write(lineBreak) + w.Write(lineBreak) + for _, link := range r.LinkStack { + if link, ok := link.(*ast.Link); ok { + r.link(w, link, true) + } + if image, ok := link.(*ast.Image); ok { + r.image(w, image, true) + } + w.Write(lineBreak) + } + r.LinkStack = nil + } +} + +func (r Renderer) code(w io.Writer, node *ast.Code, entering bool) { + // TODO: Renderer.code: no good way to test that yet + if entering { + w.Write([]byte("```\n")) + w.Write(node.Content) + } else { + w.Write([]byte("```\n\n")) + } +} + +func (r Renderer) text(w io.Writer, node *ast.Text) { + w.Write(node.Literal) +} + +// RenderNode implements Renderer.RenderNode(). +func (r Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.WalkStatus { + // despite most of the subroutines here accepting entering, most of + // them don't really need an extra pass + switch node := node.(type) { + case *ast.Link: + // TODO: shouldn't be here at all + r.link(w, node, entering) + case *ast.Image: + // TODO: neither this + r.image(w, node, entering) + case *ast.Citation: + // TODO: neither this + r.citation(w, node) + case *ast.Heading: + r.heading(w, node, entering) + case *ast.Paragraph: + r.paragraph(w, node, entering) + case *ast.Code: + // TODO: likely not even this + r.code(w, node, entering) + } + return ast.GoToNext +} + +// RenderHeader implements Renderer.RenderHeader(). +func (r Renderer) RenderHeader(w io.Writer, node ast.Node) { + // likely doesn't need any code +} + +// RenderFooter implements Renderer.RenderFooter(). +func (r Renderer) RenderFooter(w io.Writer, node ast.Node) { + // likely doesn't need any code either +} From 49725d712a2f7479d8c9277fb0c234bf82941a54 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sat, 7 Nov 2020 17:21:36 +0500 Subject: [PATCH 04/13] Add image/link text render and blockquote support --- internal/gemini/renderer.go | 121 +++++++++++++++++++++++++----------- 1 file changed, 83 insertions(+), 38 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index dab3094..3f87b40 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -9,21 +9,19 @@ import ( ) var ( - lineBreak = []byte{'\n'} - space = []byte{' '} - linkPrefix = []byte("=> ") + lineBreak = []byte{'\n'} + lineBreakByte byte = 0x0a + space = []byte{' '} + linkPrefix = []byte("=> ") + quotePrefix = []byte("> ") ) // Renderer implements markdown.Renderer. -type Renderer struct { - LinkStack []ast.Node -} +type Renderer struct{} // NewRenderer returns a new Renderer. func NewRenderer() Renderer { - return Renderer{ - LinkStack: nil, - } + return Renderer{} } func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { @@ -37,6 +35,24 @@ func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { } } +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) + } + } +} + func (r Renderer) image(w io.Writer, node *ast.Image, entering bool) { if entering { w.Write(linkPrefix) @@ -53,11 +69,34 @@ func (r Renderer) image(w io.Writer, node *ast.Image, entering bool) { } } -func (r Renderer) citation(w io.Writer, node *ast.Citation) {} +func (r Renderer) blockquote(w io.Writer, node *ast.BlockQuote, entering bool) { + // TODO: Renderer.blockquote: needs support for subnode rendering; + // ideally to be merged with paragraph + if entering { + w.Write(quotePrefix) + if para, ok := node.Children[0].(*ast.Paragraph); ok { + for _, subnode := range para.Children { + if l := subnode.AsLeaf(); l != nil { + // TODO: Renderer.blockquote: rendering by byte is asking + // for optimizations + for _, b := range l.Literal { + w.Write([]byte{b}) + if b == lineBreakByte { + w.Write(quotePrefix) + } + } + } + } + } + } else { + w.Write(lineBreak) + w.Write(lineBreak) + } +} func (r Renderer) heading(w io.Writer, node *ast.Heading, entering bool) { if entering { - // prepend headings with the relevant number of #-s + // pad headings with the relevant number of #-s heading := make([]byte, node.Level+1) heading[len(heading)-1] = ' ' for i := 0; i < len(heading)-1; i++ { @@ -75,34 +114,44 @@ func (r Renderer) heading(w io.Writer, node *ast.Heading, entering bool) { func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { if entering { - if r.LinkStack != nil { - panic("link stack not empty") - } - r.LinkStack = make([]ast.Node, 0, len(node.Children)) + linkStack := make([]ast.Node, 0, len(node.Children)) + onlyElement := len(node.Children) == 1 for _, child := range node.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 { - r.LinkStack = append(r.LinkStack, link) + if !(len(link.Children) > 1) && !onlyElement { + r.linkText(w, link) + } + linkStack = append(linkStack, link) } if image, ok := child.(*ast.Image); ok { - r.LinkStack = append(r.LinkStack, image) + if !(len(image.Children) > 1) && !onlyElement { + r.imageText(w, image) + } + linkStack = append(linkStack, image) } if text, ok := child.(*ast.Text); ok { r.text(w, text) } } + // render a links block after paragraph + if len(linkStack) > 0 { + w.Write(lineBreak) + w.Write(lineBreak) + for _, link := range linkStack { + if link, ok := link.(*ast.Link); ok { + r.link(w, link, true) + } + if image, ok := link.(*ast.Image); ok { + r.image(w, image, true) + } + w.Write(lineBreak) + } + } } else { w.Write(lineBreak) w.Write(lineBreak) - for _, link := range r.LinkStack { - if link, ok := link.(*ast.Link); ok { - r.link(w, link, true) - } - if image, ok := link.(*ast.Image); ok { - r.image(w, image, true) - } - w.Write(lineBreak) - } - r.LinkStack = nil } } @@ -125,21 +174,17 @@ func (r Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.Walk // despite most of the subroutines here accepting entering, most of // them don't really need an extra pass switch node := node.(type) { - case *ast.Link: - // TODO: shouldn't be here at all - r.link(w, node, entering) - case *ast.Image: - // TODO: neither this - r.image(w, node, entering) - case *ast.Citation: - // TODO: neither this - r.citation(w, node) + case *ast.BlockQuote: + r.blockquote(w, node, entering) case *ast.Heading: r.heading(w, node, entering) case *ast.Paragraph: - r.paragraph(w, node, entering) + // blockquote wraps paragraphs which makes for an extra render + if _, parentIsBlockQuote := node.Parent.(*ast.BlockQuote); !parentIsBlockQuote { + r.paragraph(w, node, entering) + } case *ast.Code: - // TODO: likely not even this + // TODO: *ast.Code render is likely to be merged into paragraph r.code(w, node, entering) } return ast.GoToNext From 4799b2b511e4f9651c3f9638373319b4e034c77c Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sat, 7 Nov 2020 19:22:31 +0500 Subject: [PATCH 05/13] Improve newline handling --- internal/gemini/renderer.go | 52 +++++++++++++++++++++++++------------ 1 file changed, 36 insertions(+), 16 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index 3f87b40..a21798b 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -28,9 +28,11 @@ func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { if entering { w.Write(linkPrefix) w.Write(node.Destination) - if node.Title != nil { - w.Write(space) - w.Write(node.Title) + for _, child := range node.Children { + if l := child.AsLeaf(); l != nil { + w.Write(space) + w.Write(l.Literal) + } } } } @@ -90,7 +92,6 @@ func (r Renderer) blockquote(w io.Writer, node *ast.BlockQuote, entering bool) { } } else { w.Write(lineBreak) - w.Write(lineBreak) } } @@ -108,25 +109,39 @@ func (r Renderer) heading(w io.Writer, node *ast.Heading, entering bool) { } } else { w.Write(lineBreak) - w.Write(lineBreak) } } func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { if entering { - linkStack := make([]ast.Node, 0, len(node.Children)) - onlyElement := len(node.Children) == 1 - for _, child := range node.Children { + children := node.Children + 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(node.Children) > 1 { + firstChild := node.Children[0] + _, elementIsText := firstChild.(*ast.Text) + asLeaf := firstChild.AsLeaf() + if elementIsText && asLeaf != nil && len(asLeaf.Literal) == 0 { + children = children[1:] + return true + } + } + return false + }() + onlyElement := len(children) == 1 || onlyElementWithGoMarkdownFix + 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 { - if !(len(link.Children) > 1) && !onlyElement { + if !onlyElement { r.linkText(w, link) } linkStack = append(linkStack, link) } if image, ok := child.(*ast.Image); ok { - if !(len(image.Children) > 1) && !onlyElement { + if !onlyElement { r.imageText(w, image) } linkStack = append(linkStack, image) @@ -135,9 +150,9 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { r.text(w, text) } } + w.Write(lineBreak) // render a links block after paragraph if len(linkStack) > 0 { - w.Write(lineBreak) w.Write(lineBreak) for _, link := range linkStack { if link, ok := link.(*ast.Link); ok { @@ -149,19 +164,16 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { w.Write(lineBreak) } } - } else { - w.Write(lineBreak) - w.Write(lineBreak) } } func (r Renderer) code(w io.Writer, node *ast.Code, entering bool) { - // TODO: Renderer.code: no good way to test that yet + // TODO: Renderer.code: untested yet if entering { w.Write([]byte("```\n")) w.Write(node.Content) } else { - w.Write([]byte("```\n\n")) + w.Write([]byte("```\n")) } } @@ -173,19 +185,27 @@ func (r Renderer) text(w io.Writer, node *ast.Text) { func (r Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.WalkStatus { // despite most of the subroutines here accepting entering, most of // them don't really need an extra pass + noNewLine := true switch node := node.(type) { case *ast.BlockQuote: r.blockquote(w, node, entering) + noNewLine = false case *ast.Heading: r.heading(w, node, entering) + noNewLine = false case *ast.Paragraph: // blockquote wraps paragraphs which makes for an extra render if _, parentIsBlockQuote := node.Parent.(*ast.BlockQuote); !parentIsBlockQuote { r.paragraph(w, node, entering) + noNewLine = false } case *ast.Code: // TODO: *ast.Code render is likely to be merged into paragraph r.code(w, node, entering) + noNewLine = false + } + if !noNewLine && !entering { + w.Write(lineBreak) } return ast.GoToNext } From 3d9314f0a49bd32c1e47530fa769bd3c5c9694c6 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sat, 7 Nov 2020 19:27:55 +0500 Subject: [PATCH 06/13] Make blockquote read stuff not byte-by-byte --- internal/gemini/renderer.go | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index a21798b..b3ce9c5 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -3,17 +3,18 @@ package gemini import ( + "bufio" + "bytes" "io" "github.com/gomarkdown/markdown/ast" ) var ( - lineBreak = []byte{'\n'} - lineBreakByte byte = 0x0a - space = []byte{' '} - linkPrefix = []byte("=> ") - quotePrefix = []byte("> ") + lineBreak = []byte{'\n'} + space = []byte{' '} + linkPrefix = []byte("=> ") + quotePrefix = []byte("> ") ) // Renderer implements markdown.Renderer. @@ -75,23 +76,18 @@ func (r Renderer) blockquote(w io.Writer, node *ast.BlockQuote, entering bool) { // TODO: Renderer.blockquote: needs support for subnode rendering; // ideally to be merged with paragraph if entering { - w.Write(quotePrefix) if para, ok := node.Children[0].(*ast.Paragraph); ok { for _, subnode := range para.Children { if l := subnode.AsLeaf(); l != nil { - // TODO: Renderer.blockquote: rendering by byte is asking - // for optimizations - for _, b := range l.Literal { - w.Write([]byte{b}) - if b == lineBreakByte { - w.Write(quotePrefix) - } + reader := bufio.NewScanner(bytes.NewBuffer(l.Literal)) + for reader.Scan() { + w.Write(quotePrefix) + w.Write(reader.Bytes()) + w.Write(lineBreak) } } } } - } else { - w.Write(lineBreak) } } From 6ee9efab52124b2a52cf4e99d5e713e1457fda0c Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 00:05:53 +0500 Subject: [PATCH 07/13] Improve the rendering of subsequent links --- internal/gemini/renderer.go | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index b3ce9c5..6b0b980 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -25,6 +25,9 @@ func NewRenderer() Renderer { return Renderer{} } +// TODO: lists +// TODO: code renderer + func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { if entering { w.Write(linkPrefix) @@ -108,7 +111,7 @@ func (r Renderer) heading(w io.Writer, node *ast.Heading, entering bool) { } } -func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { +func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) (noNewLine bool) { if entering { children := node.Children linkStack := make([]ast.Node, 0, len(children)) @@ -127,6 +130,18 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { return false }() onlyElement := len(children) == 1 || onlyElementWithGoMarkdownFix + onlyElementIsLink := func() bool { + if len(children) >= 1 { + if _, ok := children[0].(*ast.Link); ok { + return true + } + if _, ok := children[0].(*ast.Image); ok { + return true + } + } + return false + }() + noNewLine = onlyElementIsLink for _, child := range children { // only render links text in the paragraph if they're // combined with some other text on page @@ -146,10 +161,14 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { r.text(w, text) } } - w.Write(lineBreak) + if !onlyElementIsLink { + w.Write(lineBreak) + } // render a links block after paragraph if len(linkStack) > 0 { - w.Write(lineBreak) + if !onlyElementIsLink { + w.Write(lineBreak) + } for _, link := range linkStack { if link, ok := link.(*ast.Link); ok { r.link(w, link, true) @@ -161,6 +180,7 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) { } } } + return } func (r Renderer) code(w io.Writer, node *ast.Code, entering bool) { @@ -191,9 +211,9 @@ func (r Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.Walk noNewLine = false case *ast.Paragraph: // blockquote wraps paragraphs which makes for an extra render - if _, parentIsBlockQuote := node.Parent.(*ast.BlockQuote); !parentIsBlockQuote { - r.paragraph(w, node, entering) - noNewLine = false + _, parentIsBlockQuote := node.Parent.(*ast.BlockQuote) + if !parentIsBlockQuote { + noNewLine = r.paragraph(w, node, entering) } case *ast.Code: // TODO: *ast.Code render is likely to be merged into paragraph From 98d6ff6d5f211d5cc30277b86dda19cda418cccc Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 00:06:43 +0500 Subject: [PATCH 08/13] Add lists and subsequent link paras to test text --- cmd/gmnhg/main.go | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index 9b6c092..046a760 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -19,13 +19,23 @@ 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! -## Subheading 2 ++ Unordered list item ++ Another list item + * Indented list item. + * Another one. ++ Third. -More text here. +1. Ordered list item. +2. Another one. + * and another inset list. + * text. +3. Yay. -## Subheading 3 +## Subheading 2 More text! @@ -37,5 +47,5 @@ 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\n---\ngemini:\n---\n%s\n", text, geminiContent) + fmt.Printf("---\noriginal:\n---\n%s---\ngemini:\n---\n%s", text, geminiContent) } From b2a941bdb64ed7314d08e9d63ff88199e2eb3a6b Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 00:27:38 +0500 Subject: [PATCH 09/13] Add preformatted text block support --- cmd/gmnhg/main.go | 7 +++++++ internal/gemini/renderer.go | 21 ++++++++------------- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/cmd/gmnhg/main.go b/cmd/gmnhg/main.go index 046a760..51543b5 100644 --- a/cmd/gmnhg/main.go +++ b/cmd/gmnhg/main.go @@ -35,6 +35,13 @@ This is some more plain text. More of it! * text. 3. Yay. +` + "```" + ` +some preformatted text +another line of preformatted text + +more lines of preformatted text +` + "```" + ` + ## Subheading 2 More text! diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index 6b0b980..a03d896 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -26,7 +26,6 @@ func NewRenderer() Renderer { } // TODO: lists -// TODO: code renderer func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { if entering { @@ -183,14 +182,10 @@ func (r Renderer) paragraph(w io.Writer, node *ast.Paragraph, entering bool) (no return } -func (r Renderer) code(w io.Writer, node *ast.Code, entering bool) { - // TODO: Renderer.code: untested yet - if entering { - w.Write([]byte("```\n")) - w.Write(node.Content) - } else { - w.Write([]byte("```\n")) - } +func (r Renderer) code(w io.Writer, node *ast.CodeBlock) { + w.Write([]byte("```\n")) + w.Write(node.Literal) + w.Write([]byte("```\n")) } func (r Renderer) text(w io.Writer, node *ast.Text) { @@ -215,10 +210,10 @@ func (r Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.Walk if !parentIsBlockQuote { noNewLine = r.paragraph(w, node, entering) } - case *ast.Code: - // TODO: *ast.Code render is likely to be merged into paragraph - r.code(w, node, entering) - noNewLine = false + case *ast.CodeBlock: + r.code(w, node) + // code block is not considered a wrapping element + w.Write(lineBreak) } if !noNewLine && !entering { w.Write(lineBreak) From 5de6b9b930c6a55091efb48f4ea613f20b27014a Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 16:40:31 +0500 Subject: [PATCH 10/13] Add support for lists --- internal/gemini/renderer.go | 55 +++++++++++++++++++++++++++++++++++-- 1 file changed, 52 insertions(+), 3 deletions(-) diff --git a/internal/gemini/renderer.go b/internal/gemini/renderer.go index a03d896..2301359 100644 --- a/internal/gemini/renderer.go +++ b/internal/gemini/renderer.go @@ -5,6 +5,7 @@ package gemini import ( "bufio" "bytes" + "fmt" "io" "github.com/gomarkdown/markdown/ast" @@ -15,6 +16,8 @@ var ( space = []byte{' '} linkPrefix = []byte("=> ") quotePrefix = []byte("> ") + itemPrefix = []byte("* ") + itemIndent = []byte{'\t'} ) // Renderer implements markdown.Renderer. @@ -25,8 +28,6 @@ func NewRenderer() Renderer { return Renderer{} } -// TODO: lists - func (r Renderer) link(w io.Writer, node *ast.Link, entering bool) { if entering { w.Write(linkPrefix) @@ -188,6 +189,46 @@ func (r Renderer) code(w io.Writer, node *ast.CodeBlock) { w.Write([]byte("```\n")) } +func (r Renderer) list(w io.Writer, node *ast.List, level int) { + // the text/gemini spec included with the current Gemini spec does + // not specify anything about the formatting of lists of level >= 2, + // as of now this will just render them like in Markdown + isNumbered := (node.ListFlags & ast.ListTypeOrdered) == ast.ListTypeOrdered + for number, item := range node.Children { + item, ok := item.(*ast.ListItem) + if !ok { + panic("rendering anything but list items is not supported") + } + // this assumes github.com/gomarkdown/markdown can only produce + // list items that contain a child paragraph and possibly + // another list; this might not be true but I can hardly imagine + // a list item that contains anything else + if l := len(item.Children); l >= 1 { + for i := 0; i < level; i++ { + w.Write(itemIndent) + } + if isNumbered { + w.Write([]byte(fmt.Sprintf("%d. ", number+1))) + } else { + w.Write(itemPrefix) + } + para, ok := item.Children[0].(*ast.Paragraph) + if ok { + text, ok := para.Children[0].(*ast.Text) + if ok { + r.text(w, text) + } + } + w.Write(lineBreak) + if l >= 2 { + if list, ok := item.Children[1].(*ast.List); ok { + r.list(w, list, level+1) + } + } + } + } +} + func (r Renderer) text(w io.Writer, node *ast.Text) { w.Write(node.Literal) } @@ -207,13 +248,21 @@ func (r Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.Walk case *ast.Paragraph: // blockquote wraps paragraphs which makes for an extra render _, parentIsBlockQuote := node.Parent.(*ast.BlockQuote) - if !parentIsBlockQuote { + _, parentIsListItem := node.Parent.(*ast.ListItem) + if !parentIsBlockQuote && !parentIsListItem { noNewLine = r.paragraph(w, node, entering) } case *ast.CodeBlock: r.code(w, node) // code block is not considered a wrapping element w.Write(lineBreak) + case *ast.List: + // lists of level >= 2 are rendered recursively along with the + // first level; the list is a container + if _, parentIsDocument := node.Parent.(*ast.Document); parentIsDocument && !entering { + r.list(w, node, 0) + noNewLine = false + } } if !noNewLine && !entering { w.Write(lineBreak) From 507ec6ad885a95bc148082c2773e3d0728951769 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 17:38:15 +0500 Subject: [PATCH 11/13] Ignore test files from Git --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 66fd13c..5c6f71f 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,6 @@ # Dependency directories (remove the comment below to include it) # vendor/ + +# store test data here +test From 179a20e0dbd59eaadf37e3ffc48fde9d97051c43 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 17:40:16 +0500 Subject: [PATCH 12/13] Provide a public APIThis also introduces a simple program, md2gmn, that is meant for testingthe renderer on Markdown files. Nonetheless, it can be used as astandalone 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 9bc1f8ef61930c618070c4871f68c843b3242bc6 Mon Sep 17 00:00:00 2001 From: Timur Demin Date: Sun, 8 Nov 2020 18:27:38 +0500 Subject: [PATCH 13/13] 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 (