Shortcode examples

[arjunmehta-git]

Signed-off-by: Lee Calcote lee.calcote@layer5.io

[Copilot]

Pull request overview

This PR adds a comprehensive set of local “shortcode examples” pages to demonstrate Academy Theme, Docsy, Hextra, and Hugo built-in shortcodes, along with the static assets (images, OpenAPI spec, PDF, notebook, asciinema cast) needed to render those examples in local preview. It also restructures the previous single large examples page into a sectioned set of smaller pages.

Changes:

• Added example content pages under content/content-formatting-examples/ organized by shortcode provider (Markdown, Hugo built-ins, Docsy, Hextra, Academy Theme).
• Added supporting static assets (OpenAPI spec, images, HTML iframe content, CSV data, PDF, notebook, asciinema cast, and an SVG icon).
• Updated repo config files (.gitignore, .github/build/Makefile.core.mk) to support local development/build workflows.

Reviewed changes

Copilot reviewed 73 out of 86 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
static/examples/openapi/example.json	Adds sample OpenAPI spec for Redoc/SwaggerUI examples.
static/examples/images/kubernetes-icon.svg	Adds Kubernetes SVG used in image examples.
static/examples/images/exoscale-icon.svg	Adds Exoscale SVG used in image/icon examples.
static/examples/images/exoscale-icon.png	Adds Exoscale PNG used by figure/image examples.
static/examples/images/deploy.png	Adds deployment screenshot image for examples.
static/examples/frame-example.html	Adds HTML page for Docsy iframe shortcode demo.
static/data/csv/keys-backup.csv	Adds CSV fixture for csvtable / csvtable-roles examples.
content/include-snippet/index.md	Includeable snippet page for hextra/include example.
content/content-formatting-examples/markdown/tables.md	Adds Markdown table examples (including inline code).
content/content-formatting-examples/markdown/responsive-images.md	Adds responsive image sizing examples.
content/content-formatting-examples/markdown/markdown-basics.md	Adds basic Markdown formatting examples.
content/content-formatting-examples/markdown/lists.md	Adds ordered/unordered/task list examples.
content/content-formatting-examples/markdown/image-styling.md	Documents default image styling and HTML overrides.
content/content-formatting-examples/markdown/footnotes.md	Adds footnote syntax example page.
content/content-formatting-examples/markdown/code.md	Adds code block and inline code examples.
content/content-formatting-examples/markdown/_index.md	Adds section index for Markdown examples.
content/content-formatting-examples/index.md	Removes prior monolithic examples page.
content/content-formatting-examples/hugo-builtins/youtube.md	Adds Hugo youtube shortcode example.
content/content-formatting-examples/hugo-builtins/x.md	Adds Hugo x shortcode example.
content/content-formatting-examples/hugo-builtins/vimeo.md	Adds Hugo vimeo shortcode example.
content/content-formatting-examples/hugo-builtins/relref.md	Adds Hugo relref shortcode example.
content/content-formatting-examples/hugo-builtins/ref.md	Adds Hugo ref shortcode example.
content/content-formatting-examples/hugo-builtins/qr.md	Adds Hugo qr shortcode example.
content/content-formatting-examples/hugo-builtins/param.md	Adds Hugo param shortcode example.
content/content-formatting-examples/hugo-builtins/instagram.md	Adds Hugo instagram shortcode example.
content/content-formatting-examples/hugo-builtins/hugo-details.md	Adds Hugo built-in details shortcode example.
content/content-formatting-examples/hugo-builtins/highlight.md	Adds Hugo highlight shortcode example.
content/content-formatting-examples/hugo-builtins/figure.md	Adds Hugo figure shortcode example referencing static image.
content/content-formatting-examples/hugo-builtins/_index.md	Adds section index for Hugo built-in shortcode examples.
content/content-formatting-examples/hextra/term.md	Adds Hextra term shortcode example and docs.
content/content-formatting-examples/hextra/tabs.md	Adds Hextra tabs / tab examples including code blocks.
content/content-formatting-examples/hextra/steps.md	Adds Hextra steps shortcode example.
content/content-formatting-examples/hextra/pdf/sample.pdf	Adds sample PDF asset for hextra/pdf demo.
content/content-formatting-examples/hextra/pdf/index.md	Adds Hextra pdf shortcode example page.
content/content-formatting-examples/hextra/jupyter/index.md	Adds Hextra jupyter shortcode example page.
content/content-formatting-examples/hextra/jupyter/example-notebook.ipynb	Adds notebook fixture for hextra/jupyter demo.
content/content-formatting-examples/hextra/include.md	Adds Hextra include shortcode example page.
content/content-formatting-examples/hextra/icon.md	Adds Hextra icon shortcode example page.
content/content-formatting-examples/hextra/filetree.md	Adds Hextra filetree shortcode example page.
content/content-formatting-examples/hextra/details.md	Adds Hextra details shortcode example page.
content/content-formatting-examples/hextra/cards.md	Adds Hextra cards / card shortcode example page.
content/content-formatting-examples/hextra/callout.md	Adds Hextra callout shortcode example page.
content/content-formatting-examples/hextra/badge.md	Adds Hextra badge shortcode example page.
content/content-formatting-examples/hextra/asciinema/index.md	Adds Hextra asciinema shortcode example page.
content/content-formatting-examples/hextra/asciinema/demo.cast	Adds asciinema cast fixture for hextra/asciinema demo.
content/content-formatting-examples/hextra/_index.md	Adds section index for Hextra shortcode examples.
content/content-formatting-examples/docsy/tabpanel.md	Adds Docsy tabpane/tab example page.
content/content-formatting-examples/docsy/tabpane-tab.md	Adds another Docsy tab example page with image.
content/content-formatting-examples/docsy/swaggerui.md	Adds Docsy swaggerui shortcode example page.
content/content-formatting-examples/docsy/redoc.md	Adds Docsy redoc shortcode example page.
content/content-formatting-examples/docsy/readfile.md	Adds Docsy readfile shortcode example page.
content/content-formatting-examples/docsy/imgproc/logo.png	Adds page resource for Docsy imgproc demo.
content/content-formatting-examples/docsy/imgproc/index.md	Adds Docsy imgproc shortcode example page.
content/content-formatting-examples/docsy/iframe.md	Adds Docsy iframe shortcode example page.
content/content-formatting-examples/docsy/docsy-pageinfo.md	Adds Docsy pageinfo shortcode example page.
content/content-formatting-examples/docsy/docsy-alert.md	Adds Docsy alert parameter-syntax example page.
content/content-formatting-examples/docsy/conditional-text.md	Adds Docsy conditional-text shortcode example page.
content/content-formatting-examples/docsy/comment.md	Adds Docsy comment shortcode example page.
content/content-formatting-examples/docsy/cardpane.md	Adds Docsy cardpane + nested card examples.
content/content-formatting-examples/docsy/card.md	Adds Docsy card shortcode example page.
content/content-formatting-examples/docsy/blocks-section-feature.md	Adds Docsy blocks/section + blocks/feature example.
content/content-formatting-examples/docsy/blocks-lead.md	Adds Docsy blocks/lead shortcode example.
content/content-formatting-examples/docsy/blocks-cover-link-down/logo.png	Adds page resource logo for Docsy cover example.
content/content-formatting-examples/docsy/blocks-cover-link-down/index.md	Adds Docsy blocks/cover + blocks/link-down example.
content/content-formatting-examples/docsy/blocks-cover-link-down/background.png	Adds background resource for Docsy cover example.
content/content-formatting-examples/docsy/_index.md	Adds section index for Docsy shortcode examples.
content/content-formatting-examples/academy-theme/version.md	Adds Academy Theme version shortcode example page.
content/content-formatting-examples/academy-theme/usestatic.md	Adds Academy Theme usestatic shortcode example page.
content/content-formatting-examples/academy-theme/theme-pageinfo.md	Adds Academy Theme pageinfo shortcode example page.
content/content-formatting-examples/academy-theme/theme-details.md	Adds Academy Theme details shortcode example page.
content/content-formatting-examples/academy-theme/svg.md	Adds Academy Theme svg shortcode example page.
content/content-formatting-examples/academy-theme/meshery-design-embed/index.md	Adds Academy Theme meshery-design-embed example page.
content/content-formatting-examples/academy-theme/local-video.md	Adds Academy Theme local-video docs/example page.
content/content-formatting-examples/academy-theme/lab-intro.md	Adds Academy Theme lab-intro shortcode example page.
content/content-formatting-examples/academy-theme/image.md	Adds Academy Theme image shortcode example page.
content/content-formatting-examples/academy-theme/embedded-design.md	Adds embedded design example using meshery-design-embed.
content/content-formatting-examples/academy-theme/csvtable.md	Adds Academy Theme csvtable shortcode example page.
content/content-formatting-examples/academy-theme/csvtable-roles.md	Adds Academy Theme csvtable-roles shortcode example page.
content/content-formatting-examples/academy-theme/chapterstyle.md	Adds Academy Theme chapterstyle shortcode example page.
content/content-formatting-examples/academy-theme/alerts.md	Adds Academy Theme alert shortcode example page.
content/content-formatting-examples/academy-theme/_index.md	Adds section index for Academy Theme shortcode examples.
content/content-formatting-examples/_index.md	Adds new section landing page replacing removed monolith.
assets/icons/exoscale-demo.svg	Adds SVG icon asset for the Academy Theme svg shortcode.
.gitignore	Ignores .DS_Store files.
.github/build/Makefile.core.mk	Updates Go version setting and comments out adapter URL list.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

swaggerui is pointing at examples/openapi/example.json without a leading /. From this page’s URL, that relative path will resolve under /content-formatting-examples/docsy/... and 404. Use an absolute path to the static file (e.g., /examples/openapi/example.json) so it resolves correctly regardless of the current page location.

[Copilot]

redoc is using a relative spec path (examples/openapi/example.json). On nested pages this will resolve relative to the page URL and likely 404. Prefer an absolute path to the static file (e.g., /examples/openapi/example.json) to make the example work reliably.

[Copilot]

The table rows start with ||, which Markdown will interpret as an extra empty first column. If the intent is a 3-column table, change the leading || to a single | on each row (header and body).

[Copilot]

Same issue as above: these rows start with ||, which adds an unintended empty first column. Use a single leading | per row for a 2-column table.