Skip to content

docs: add internal shortcode formatting examples#239

Open
YASHMAHAKAL wants to merge 1 commit into
layer5io:masterfrom
YASHMAHAKAL:docs
Open

docs: add internal shortcode formatting examples#239
YASHMAHAKAL wants to merge 1 commit into
layer5io:masterfrom
YASHMAHAKAL:docs

Conversation

@YASHMAHAKAL

@YASHMAHAKAL YASHMAHAKAL commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Notes for Reviewers
Adds the standard content-formatting-examples reference section, consistent with academy-example. This provides contributors with an internal-facing, locally-viewable cheat sheet of all available shortcodes across academy-theme, Docsy, Hextra, Hugo built-ins, and Markdown. Also enables markup.goldmark.renderer.unsafe in hugo.yaml to ensure all shortcodes render correctly.

This PR fixes : layer5io/academy-example#155

note: omitted "org-id" file

Signed commits

  • Yes, I signed my commits.

Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

🚀 Preview deployment: https://layer5io.github.io/layer5-academy/pr-preview/pr-239/

Note: Preview may take a moment (GitHub Pages deployment in progress). Please wait and refresh. Track deployment here

@Bhumikagarggg Bhumikagarggg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Image everything looks good to me except the index page. @YASHMAHAKAL Do you know why this got changed?

@Bhumikagarggg Bhumikagarggg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@YASHMAHAKAL Enabling unsafe globally causes the existing homepage blocks/lead shortcode to render as a primary-colored section, adding a green background behind “Welcome to dev environment for your Academy”. This visual change is unrelated to the content-formatting examples. Please either avoid enabling unsafe globally or adjust the homepage shortcode/content so this PR does not change the index page appearance.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Propagate internal shortcode formatting examples to all meshery-academy repositories

2 participants