Skip to content

Commit

Permalink
Document Page.Markup
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring committed Aug 15, 2024
1 parent 2f793d3 commit a267a50
Show file tree
Hide file tree
Showing 2 changed files with 96 additions and 0 deletions.
25 changes: 25 additions & 0 deletions content/en/functions/hugo/Context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: hugo.Context
description: # TODO
categories: []
keywords: []
action:
aliases: []
related: []
returnType: string
signatures: [hugo.Context]
---

<!-- TODO -->

## Contexts

<!-- TODO -->

###### MarkupScope

<!-- TODO -->

```go-html-template
{{ hugo.Context.MarkupScope }} → xxxxxx
```
71 changes: 71 additions & 0 deletions content/en/methods/page/Markup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Markup
description: # TODO
categories: []
keywords: []
action:
related: []
returnType: # TODO
signatures: [PAGE.Markup]
---

<!-- TODO -->

<!-- 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 }}
```

0 comments on commit a267a50

Please sign in to comment.