Skip to content

Conversation

Copy link

Copilot AI commented Dec 19, 2025

No documentation existed for the 24 Hugo shortcodes used in the project, making it difficult for contributors to discover and use them correctly.

Changes

  • Added SHORTCODES.md - Complete reference for all shortcodes with:

    • Usage examples and parameter descriptions
    • Categorization by function (alerts, layout, brand-specific, media, navigation, utilities)
    • Markdown support notes and best practices
  • Updated README.md - Added reference to shortcodes documentation in project contents section

Example Usage

{{% tip %}}
Use `system-name` shortcode for brand-agnostic content.
{{% /tip %}}

{{% only sys="wc" %}}
WebChart-specific content here
{{% /only %}}

{{< youtube "dQw4w9WgXcQ" >}}

All 24 shortcodes now documented: alert types (info/note/tip/warning), layout helpers (row/column/section), brand-specific rendering (system-name/only), media embeds (youtube/gvideo), navigation (children/toc), and utilities.

Original prompt

This section details on the original issue you should resolve

<issue_title>Add documentation for Hugo shortcodes</issue_title>
<issue_description>Currently, there is no documentation describing the available Hugo shortcodes, their purpose, or how to use them. This makes it difficult for contributors and users to discover existing functionality and apply it correctly.

It would be helpful to have documentation that includes:

  • A list of all supported shortcodes
  • A brief description of what each shortcode does
  • Usage examples (including parameters and defaults)
  • Any constraints or caveats

Suggested locations could be the project README, a dedicated documentation page, or inline docs under layouts/shortcodes.

Adding this would significantly improve usability and reduce onboarding friction.

Expected outcome:

Clear, centralized documentation for all Hugo shortcodes used in the project.
If shortcodes are not used in the project, there should be a note, they can be delated. </issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: pierzchala-m <162727606+pierzchala-m@users.noreply.github.com>
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 19, 2025

Deploying eh-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: de92f84
Status: ✅  Deploy successful!
Preview URL: https://02842a6f.eh-docs.pages.dev
Branch Preview URL: https://copilot-add-hugo-shortcodes.eh-docs.pages.dev

View logs

Copilot AI changed the title [WIP] Add documentation for Hugo shortcodes Add comprehensive Hugo shortcodes documentation Dec 19, 2025
Copilot AI requested a review from pierzchala-m December 19, 2025 14:28
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.

Add documentation for Hugo shortcodes

2 participants