summaryrefslogtreecommitdiffstats
path: root/markup/goldmark
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2023-02-11 16:20:24 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2023-02-21 17:56:41 +0100
commit90da7664bf1f3a0ca2e18144b5deacf532c6e3cf (patch)
tree78d8ac72ebb2ccee4ca4bbeeb9add3365c743e90 /markup/goldmark
parent0afec0a9f4aace1f5f4af6822aeda6223ee3e3a9 (diff)
Add page fragments support to Related
The main topic of this commit is that you can now index fragments (content heading identifiers) when calling `.Related`. You can do this by: * Configure one or more indices with type `fragments` * The name of those index configurations maps to an (optional) front matter slice with fragment references. This allows you to link page<->fragment and page<->page. * This also will index all the fragments (heading identifiers) of the pages. It's also possible to use type `fragments` indices in shortcode, e.g.: ``` {{ $related := site.RegularPages.Related .Page }} ``` But, and this is important, you need to include the shortcode using the `{{<` delimiter. Not doing so will create infinite loops and timeouts. This commit also: * Adds two new methods to Page: Fragments (can also be used to build ToC) and HeadingsFiltered (this is only used in Related Content with index type `fragments` and `enableFilter` set to true. * Consolidates all `.Related*` methods into one, which takes either a `Page` or an options map as its only argument. * Add `context.Context` to all of the content related Page API. Turns out it wasn't strictly needed for this particular feature, but it will soon become usefil, e.g. in #9339. Closes #10711 Updates #9339 Updates #10725
Diffstat (limited to 'markup/goldmark')
-rw-r--r--markup/goldmark/convert.go10
-rw-r--r--markup/goldmark/toc.go10
2 files changed, 10 insertions, 10 deletions
diff --git a/markup/goldmark/convert.go b/markup/goldmark/convert.go
index a179cd233..6c1c7ad0a 100644
--- a/markup/goldmark/convert.go
+++ b/markup/goldmark/convert.go
@@ -160,11 +160,11 @@ var _ identity.IdentitiesProvider = (*converterResult)(nil)
type converterResult struct {
converter.Result
- toc tableofcontents.Root
+ toc *tableofcontents.Fragments
ids identity.Identities
}
-func (c converterResult) TableOfContents() tableofcontents.Root {
+func (c converterResult) TableOfContents() *tableofcontents.Fragments {
return c.toc
}
@@ -228,9 +228,9 @@ type parserContext struct {
parser.Context
}
-func (p *parserContext) TableOfContents() tableofcontents.Root {
+func (p *parserContext) TableOfContents() *tableofcontents.Fragments {
if v := p.Get(tocResultKey); v != nil {
- return v.(tableofcontents.Root)
+ return v.(*tableofcontents.Fragments)
}
- return tableofcontents.Root{}
+ return nil
}
diff --git a/markup/goldmark/toc.go b/markup/goldmark/toc.go
index 396c1d071..ac5040e85 100644
--- a/markup/goldmark/toc.go
+++ b/markup/goldmark/toc.go
@@ -41,8 +41,8 @@ func (t *tocTransformer) Transform(n *ast.Document, reader text.Reader, pc parse
}
var (
- toc tableofcontents.Root
- tocHeading tableofcontents.Heading
+ toc tableofcontents.Builder
+ tocHeading = &tableofcontents.Heading{}
level int
row = -1
inHeading bool
@@ -53,10 +53,10 @@ func (t *tocTransformer) Transform(n *ast.Document, reader text.Reader, pc parse
s := ast.WalkStatus(ast.WalkContinue)
if n.Kind() == ast.KindHeading {
if inHeading && !entering {
- tocHeading.Text = headingText.String()
+ tocHeading.Title = headingText.String()
headingText.Reset()
toc.AddAt(tocHeading, row, level-1)
- tocHeading = tableofcontents.Heading{}
+ tocHeading = &tableofcontents.Heading{}
inHeading = false
return s, nil
}
@@ -106,7 +106,7 @@ func (t *tocTransformer) Transform(n *ast.Document, reader text.Reader, pc parse
return s, nil
})
- pc.Set(tocResultKey, toc)
+ pc.Set(tocResultKey, toc.Build())
}
type tocExtension struct {