task: back to single internal package

go.mod

@@ -12,7 +12,6 @@ require (
 
 require (
 	github.com/kr/pretty v0.3.1 // indirect
-	github.com/stretchr/testify v1.8.4 // indirect
 	golang.org/x/sys v0.16.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/yaml.v2 v2.3.0 // indirect

go.sum

@@ -12,8 +12,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
 github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
+github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 github.com/yuin/goldmark v1.5.4 h1:2uY/xC0roWy8IBEGLgB1ywIoEJFGmRrX21YQcvGZzjU=
 github.com/yuin/goldmark v1.5.4/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
 github.com/yuin/goldmark-meta v1.1.0 h1:pWw+JLHGZe8Rk0EGsMVssiNb/AaPMHfSRszZeUeiOUc=

internal/config/config.go → internal/config.go

@@ -1,11 +1,13 @@
-package config
+package internal
 
 import (
+	"bytes"
 	"io"
 	"os"
 	"path/filepath"
 
-	"github.com/paganotoni/doco/internal/markdown"
+	meta "github.com/yuin/goldmark-meta"
+	"github.com/yuin/goldmark/parser"
 )
 
 const (
@@ -15,7 +17,7 @@ const (
 )
 
 // config of the general elements of the site.
-type Site struct {
+type siteConfig struct {
 	Name        string
 	Favicon     string
 	Description string
@@ -41,7 +43,7 @@ type Link struct {
 // Read parses the _meta.md file and returns the config
 // for the site.
 // TODO: change this to receive the file access (fs package?) instead of the folder.
-func Read(folder string) (c Site, err error) {
+func readConfig(folder string) (c siteConfig, err error) {
 	file, err := os.Open(filepath.Join(folder, metafile))
 	if err != nil {
 		return c, err
@@ -54,11 +56,14 @@ func Read(folder string) (c Site, err error) {
 		return c, err
 	}
 
-	meta, err := markdown.ReadMetadata(content)
-	if err != nil {
+	// Parse the metadata and apply it to the document
+	var buf bytes.Buffer
+	context := parser.NewContext()
+	if err := mparser.Convert(content, &buf, parser.WithContext(context)); err != nil {
 		return c, err
 	}
 
+	meta := meta.Get(context)
 	def := func(val any, defs string) string {
 		v, ok := val.(string)
 		if !ok || v == "" {

internal/config/config_test.go → internal/config_test.go

@@ -1,4 +1,4 @@
-package config
+package internal
 
 import (
 	_ "embed"
@@ -41,7 +41,7 @@ func TestReadConfig(t *testing.T) {
 			t.Fatal(err)
 		}
 
-		_, err = Read(tmpdir)
+		_, err = readConfig(tmpdir)
 		if err != nil {
 			t.Fatal(err)
 		}
@@ -70,7 +70,7 @@ func TestReadConfig(t *testing.T) {
 			t.Fatal(err)
 		}
 
-		_, err = Read(tmpdir)
+		_, err = readConfig(tmpdir)
 		if err != nil {
 			t.Fatal(err)
 		}

internal/document.go

@@ -1,12 +1,14 @@
 package internal
 
 import (
+	"bytes"
 	"fmt"
 	"path"
 	"path/filepath"
 	"strings"
 
-	"github.com/paganotoni/doco/internal/markdown"
+	meta "github.com/yuin/goldmark-meta"
+	"github.com/yuin/goldmark/parser"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 )
@@ -15,11 +17,13 @@ import (
 // and returns a parsed document with the metadata applied.
 func NewDocument(path string, content []byte) (document, error) {
 	// Parse the metadata and apply it to the document
-	meta, err := markdown.ReadMetadata(content)
-	if err != nil {
-		return document{}, fmt.Errorf("error parsing metadata for %v: %w", path, err)
+	var buf bytes.Buffer
+	context := parser.NewContext()
+	if err := mparser.Convert(content, &buf, parser.WithContext(context)); err != nil {
+		return document{}, err
 	}
 
+	meta := meta.Get(context)
 	title, ok := meta["title"].(string)
 	if !ok {
 		// Humanizing the filename into a title

internal/generate.go

@@ -10,8 +10,11 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/paganotoni/doco/internal/config"
-	"github.com/paganotoni/doco/internal/markdown"
+	"github.com/yuin/goldmark"
+
+	meta "github.com/yuin/goldmark-meta"
+	"github.com/yuin/goldmark/parser"
+	"go.abhg.dev/goldmark/anchor"
 )
 
 var (
@@ -25,18 +28,30 @@ var (
 	pageHTML string
 	pageTmpl = template.Must(
 		template.New("page").Funcs(template.FuncMap{
-			// htmlFrom generates html from markdown
-			// this is useful for the content of the page
-			// to be generated.
-			"htmlFrom": func(m []byte) template.HTML {
-				c, err := markdown.HTMLFrom(m)
-				if err != nil {
-					return ""
-				}
-				return template.HTML(c)
-			},
+			"htmlFrom": htmlFromMarkdown,
 		}).Parse(pageHTML),
 	)
+
+	// mparser is the markdown parser used to parse the content
+	mparser = goldmark.New(
+		goldmark.WithParserOptions(
+			parser.WithAutoHeadingID(), // read note
+		),
+
+		goldmark.WithExtensions(
+			meta.Meta,
+
+			// anchor is used to generate anchor links for headings
+			// in the markdown file.
+			&anchor.Extender{
+				Texter: anchor.Text("#"),
+				Attributer: anchor.Attributes{
+					"class": "heading-anchor",
+					"alt":   "Link to this section",
+				},
+			},
+		),
+	)
 )
 
 // Generates the static html files for the site
@@ -48,7 +63,7 @@ func Generate(srcFolder, destination string, s *site) error {
 		return err
 	}
 
-	conf, err := config.Read(srcFolder)
+	conf, err := readConfig(srcFolder)
 	if err != nil {
 		return err
 	}
@@ -62,7 +77,7 @@ func Generate(srcFolder, destination string, s *site) error {
 		}
 
 		type docData struct {
-			Config config.Site
+			Config siteConfig
 			Site   *site
 
 			Title       string
@@ -172,3 +187,15 @@ func copyDir(src string, dst string) error {
 		return os.Chmod(dstPath, info.Mode())
 	})
 }
+
+// htmlFromMarkdown generates html from markdown
+// this is useful for the content of the page
+// to be generated.
+func htmlFromMarkdown(m []byte) template.HTML {
+	var buf bytes.Buffer
+	if err := mparser.Convert(m, &buf); err != nil {
+		return template.HTML("")
+	}
+
+	return template.HTML(buf.String())
+}

internal/site.go

@@ -1,14 +1,16 @@
 package internal
 
 import (
+	"bytes"
 	"fmt"
 	"io"
 	"os"
 	"path/filepath"
 	"sort"
 	"strings"
 
-	"github.com/paganotoni/doco/internal/markdown"
+	meta "github.com/yuin/goldmark-meta"
+	"github.com/yuin/goldmark/parser"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 )
@@ -61,14 +63,19 @@ func NewSite(folder string) (*site, error) {
 				continue
 			}
 
-			meta, err := markdown.ReadMetadata(bb)
-			if err == nil {
-				var ok bool
-				site.Sections[i].index, ok = meta["index"].(int)
-				if !ok {
-					// 10 million to make sure it is the last one by default
-					v.index = 10_000_000
-				}
+			// Parse the metadata and apply it to the document
+			var buf bytes.Buffer
+			context := parser.NewContext()
+			if err := mparser.Convert(bb, &buf, parser.WithContext(context)); err != nil {
+				continue
+			}
+
+			meta := meta.Get(context)
+			var ok bool
+			site.Sections[i].index, ok = meta["index"].(int)
+			if !ok {
+				// 10 million to make sure it is the last one by default
+				v.index = 10_000_000
 			}
 		}
 	}