Skip to content

Add an option to not display descriptions#1533

Open
xuhdev wants to merge 1 commit intoadityatelange:masterfrom
xuhdev:description
Open

Add an option to not display descriptions#1533
xuhdev wants to merge 1 commit intoadityatelange:masterfrom
xuhdev:description

Conversation

@xuhdev
Copy link
Contributor

@xuhdev xuhdev commented May 31, 2024

.Description is meant to be used for metadata purpose: https://gohugo.io/methods/page/description/

Hugo document has emphasized this in the .Description page:

Conceptually different from a content summary, a page description is typically used in metadata about the page.

Hugo embedded templates are consistent in this regard.

To maintain backward compatibility, add an option showDescription to disable displaying descriptions.

PR Checklist

  • This change adds/updates translations and I have used the template present here.
  • I have enabled maintainer edits for this PR.
  • I have verified that the code works as described/as intended.
  • This change adds a Social Icon which has a permissive license to use it.
  • This change does not include any CDN resources/links.
  • This change does not include any unrelated scripts such as bash and python scripts.
  • This change updates the overridden internal templates from HUGO's repository.

.Description is meant to be used for metadata purpose: https://gohugo.io/methods/page/description/

Hugo document has emphasized this in the .Description page:

> Conceptually different from a content summary, a page description is typically used in metadata about the page.

Hugo embedded templates are consistent in this regard.

To maintain backward compatibility, add an option showDescription to
disable displaying descriptions.
@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant