Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Page.Markup #2669

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Copy link
Member

@bep bep Aug 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want to have the method live in both places forever.


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