allow frontmatter to be added to properties and use title in the layout

Author: emad-elsaid

extensions/all/all.go

@@ -11,6 +11,7 @@ import (
 	_ "github.com/emad-elsaid/xlog/extensions/editor"
 	_ "github.com/emad-elsaid/xlog/extensions/embed"
 	_ "github.com/emad-elsaid/xlog/extensions/file_operations"
+	_ "github.com/emad-elsaid/xlog/extensions/frontmatter"
 	_ "github.com/emad-elsaid/xlog/extensions/github"
 	_ "github.com/emad-elsaid/xlog/extensions/gpg"
 	_ "github.com/emad-elsaid/xlog/extensions/hashtags"

extensions/frontmatter/extension.go

@@ -0,0 +1,53 @@
+package frontmatter
+
+import (
+	"github.com/emad-elsaid/xlog"
+	meta "github.com/yuin/goldmark-meta"
+)
+
+func init() {
+	xlog.RegisterExtension(Frontmatter{})
+}
+
+type Frontmatter struct{}
+
+func (Frontmatter) Name() string { return "frontmatter" }
+func (Frontmatter) Init() {
+	m := meta.New(
+		meta.WithStoresInDocument(),
+	)
+
+	m.Extend(xlog.MarkdownConverter())
+	xlog.RegisterProperty(MetaProperties)
+}
+
+type MetaProperty struct {
+	NameVal string
+	Val     any
+}
+
+func (m MetaProperty) Name() string { return m.NameVal }
+func (m MetaProperty) Icon() string { return "fa-solid fa-table-list" }
+func (m MetaProperty) Value() any   { return m.Val }
+
+func MetaProperties(p xlog.Page) []xlog.Property {
+	_, ast := p.AST()
+	if ast == nil {
+		return nil
+	}
+
+	metaData := ast.OwnerDocument().Meta()
+	if len(metaData) == 0 {
+		return nil
+	}
+
+	ps := make([]xlog.Property, 0, len(metaData))
+	for k, v := range metaData {
+		ps = append(ps, MetaProperty{
+			NameVal: k,
+			Val:     v,
+		})
+	}
+
+	return ps
+}

go.mod

@@ -21,6 +21,7 @@ require (
 	github.com/hashicorp/golang-lru/v2 v2.0.7
 	github.com/rjeczalik/notify v0.9.3
 	github.com/stretchr/testify v1.10.0
+	github.com/yuin/goldmark-meta v1.1.0
 	gitlab.com/greyxor/slogor v1.5.2
 	golang.org/x/sync v0.6.0
 	gopkg.in/yaml.v3 v3.0.1
@@ -30,6 +31,7 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	golang.org/x/net v0.23.0 // indirect
+	gopkg.in/yaml.v2 v2.3.0 // indirect
 )
 
 require (

go.sum

@@ -66,6 +66,8 @@ github.com/yuin/goldmark-emoji v1.0.2 h1:c/RgTShNgHTtc6xdz2KKI74jJr6rWi7FPgnP9GA
 github.com/yuin/goldmark-emoji v1.0.2/go.mod h1:RhP/RWpexdp+KHs7ghKnifRoIs/Bq4nDS7tRbCkOwKY=
 github.com/yuin/goldmark-highlighting/v2 v2.0.0-20230729083705-37449abec8cc h1:+IAOyRda+RLrxa1WC7umKOZRsGq4QrFFMYApOeHzQwQ=
 github.com/yuin/goldmark-highlighting/v2 v2.0.0-20230729083705-37449abec8cc/go.mod h1:ovIvrum6DQJA4QsJSovrkC4saKHQVs7TvcaeO8AIl5I=
+github.com/yuin/goldmark-meta v1.1.0 h1:pWw+JLHGZe8Rk0EGsMVssiNb/AaPMHfSRszZeUeiOUc=
+github.com/yuin/goldmark-meta v1.1.0/go.mod h1:U4spWENafuA7Zyg+Lj5RqK/MF+ovMYtBvXi1lBb2VP0=
 gitlab.com/greyxor/slogor v1.5.2 h1:ushBskVMbduRt3mWLpIct9mOGAkxnytVNoSn2IHBgXM=
 gitlab.com/greyxor/slogor v1.5.2/go.mod h1:P8dDYZxKsh/omu91z+vep/m78GxWEOc2KP2f0zaCasE=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
@@ -131,6 +133,8 @@ google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGm
 google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 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=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

property.go

@@ -36,7 +36,7 @@ func Properties(p Page) map[string]Property {
 type lastUpdateProp struct{ page Page }
 
 func (a lastUpdateProp) Icon() string { return "fa-solid fa-clock" }
-func (a lastUpdateProp) Name() string { return "Modified" }
+func (a lastUpdateProp) Name() string { return "modified" }
 func (a lastUpdateProp) Value() any   { return ago(a.page.ModTime()) }
 
 func defaultProps(p Page) []Property {

templates/layout.html

@@ -7,7 +7,12 @@
     <link rel="icon" href="/public/logo.png">
     <link rel="stylesheet" href="/public/style.css">
     <title>
-      {{- with .page }}{{ .Emoji }} {{ .Name }} | {{ end -}}
+      {{ $props := properties .page }}
+      {{- with .page -}}
+      {{ .Emoji }}
+      {{ with $props.title }} {{ .Value }} {{ else }} {{ .Name }} {{ end }}
+      |
+      {{- end -}}
       {{.config.Sitename}}
     </title>
     {{- with .page }} {{ widgets "head" . }} {{ end }}
@@ -21,7 +26,8 @@
       {{- if ne .config.Index .page.Name -}}
       <div dir="auto" class="title is-1 has-text-weight-bold">
         {{- with .page -}}
-        {{- .Emoji }} {{ .Name -}}
+        {{- .Emoji }}
+        {{ with $props.title }} {{ .Value }} {{ else }} {{ .Name }} {{ end }}
         {{- end -}}
       </div>
       {{- end -}}

templates/pages.html

@@ -1,7 +1,10 @@
 <ul>
   {{- range . -}}
   <li>
-    <a href="/{{.Name}}" dir="auto">{{ .Emoji }} {{ .Name }}</a>
+    <a href="/{{.Name}}" dir="auto">{{ .Emoji }}
+      {{ $props := properties . }}
+      {{ with $props.title }} {{ .Value }} {{ else }} {{ .Name }} {{ end }}
+    </a>
     <time class="has-text-grey is-size-7">{{ ago .ModTime }}</time>
   </li>
   {{- end -}}