-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
jmooring
wants to merge
1
commit into
gohugoio:master
Choose a base branch
from
jmooring:document-page-dot-contents
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Document Page.Markup #2669
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 }} | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.