Document Page.Markup

This commit is contained in:
Joe Mooring 2024-08-13 13:25:58 -07:00
parent a5a4fa9075
commit 8567ccde82
2 changed files with 98 additions and 0 deletions

View File

@ -0,0 +1,26 @@
---
title: hugo.Context
description: # TODO
categories: []
keywords: []
params:
functions_and_methods:
aliases: []
returnType: string
signatures: [hugo.Context]
---
<!-- TODO -->
<!-- https://github.com/gohugoio/hugo/pull/12759 -->
## Contexts
<!-- TODO -->
###### MarkupScope
<!-- TODO -->
```go-html-template
{{ hugo.Context.MarkupScope }} → xxxxxx
```

View File

@ -0,0 +1,72 @@
---
title: Markup
description: # TODO
categories: []
keywords: []
params:
functions_and_methods:
returnType: # TODO
signatures: [PAGE.Markup]
---
<!-- TODO -->
<!-- https://github.com/gohugoio/hugo/pull/12759 -->
<!-- JMM It is unclear to me if things like .Page.WordCount will be deprecated in favor of .Page.Markup.CountWords. Three levels (Page, Markup, Countwords) is a bit of a pain to document with the current docs theme. Several of the Markup methods required their own page.
So maybe make Markup a first-level method, noting that it's a method on Page. Then each method on Markup will have its own page.
-->
## Methods
###### CountWords
(`int`) <!-- TODO -->
###### CountWordsFuzzy
(`int`) <!-- TODO -->
###### Fragments
(`tableofcontents.Fragments`) <!-- TODO -->
###### FragmentsHTML
(`template.HTML`) <!-- TODO -->
###### HasShortcode
(`bool`) <!-- TODO -->
###### Len
(`int`) <!-- TODO -->
###### Plain
(`string`) <!-- TODO -->
###### PlainWords
(`string array`) <!-- TODO -->
###### ReadingTime
(`int`) <!-- TODO -->
###### Render
(`any`) <!-- TODO -->
###### RenderShortcodes
(`template.HTM`) <!-- TODO -->
###### RenderString
(`template.HTM`) <!-- TODO -->
###### Summary
(`template.HTML`) <!-- TODO -->
## Example
<!-- TODO -->
```go-html-template
{{ range .Pages }}
{{ with .Markup }}
{{ .Countwords }}
{{ .Render }}
{{ end }}
{{ end }}
```