aboutsummaryrefslogtreecommitdiffstats
path: root/modules/markup/markdown/meta.go
diff options
context:
space:
mode:
Diffstat (limited to 'modules/markup/markdown/meta.go')
-rw-r--r--modules/markup/markdown/meta.go49
1 files changed, 49 insertions, 0 deletions
diff --git a/modules/markup/markdown/meta.go b/modules/markup/markdown/meta.go
new file mode 100644
index 0000000000..ca95e4d26a
--- /dev/null
+++ b/modules/markup/markdown/meta.go
@@ -0,0 +1,49 @@
+// Copyright 2020 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package markdown
+
+import (
+ "errors"
+ "strings"
+
+ "gopkg.in/yaml.v2"
+)
+
+func isYAMLSeparator(line string) bool {
+ line = strings.TrimSpace(line)
+ for i := 0; i < len(line); i++ {
+ if line[i] != '-' {
+ return false
+ }
+ }
+ return len(line) > 2
+}
+
+// ExtractMetadata consumes a markdown file, parses YAML frontmatter,
+// and returns the frontmatter metadata separated from the markdown content
+func ExtractMetadata(contents string, out interface{}) (string, error) {
+ var front, body []string
+ var seps int
+ lines := strings.Split(contents, "\n")
+ for idx, line := range lines {
+ if seps == 2 {
+ front, body = lines[:idx], lines[idx:]
+ break
+ }
+ if isYAMLSeparator(line) {
+ seps++
+ continue
+ }
+ }
+
+ if len(front) == 0 && len(body) == 0 {
+ return "", errors.New("could not determine metadata")
+ }
+
+ if err := yaml.Unmarshal([]byte(strings.Join(front, "\n")), out); err != nil {
+ return "", err
+ }
+ return strings.Join(body, "\n"), nil
+}