-
Notifications
You must be signed in to change notification settings - Fork 44
Add example OpenAPI document, iframe example, video file, and keys backup CSV #375
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,105 @@ | ||||||
| --- | ||||||
| title: Content Formatting Examples | ||||||
| weight: 5 | ||||||
| description: A collection of shortcode examples for formatting content, from basic Markdown text to advanced custom components. | ||||||
| draft: true | ||||||
| --- | ||||||
|
|
||||||
| {{< alert type="danger" title="Example Page: Not for Production" >}} | ||||||
| This page will not be published in the [production version](https://cloud.layer5.io/academy/) of your Academy site. It is only visible for local preview (`draft: true`) and serves as a reference. You can safely delete this page from your repository at any time. | ||||||
| {{< /alert >}} | ||||||
|
|
||||||
| The Layer5 Academy platform supports a wide range of shortcodes for enriching your learning content. Shortcodes are reusable template snippets you invoke in Markdown files to generate HTML output. | ||||||
|
|
||||||
| Using a shortcode looks like this: | ||||||
|
|
||||||
| ```code | ||||||
| { {% shortcode-name %}} | ||||||
|
||||||
| { {% shortcode-name %}} | |
| {{% shortcode-name %}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| title: Alerts | ||
| linkTitle: Alerts | ||
| weight: 345 | ||
| description: Examples of the alert shortcode variants. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< alert title="Note" >}}A plain alert with a title.{{< /alert >}} | ||
| {{< alert type="note" title="Note" >}}This alert supports a title and **Markdown**.{{< /alert >}} | ||
| {{< alert type="info" title="Info" >}}This is an informational alert.{{< /alert >}} | ||
| {{< alert type="danger" title="Danger" >}}This is a danger alert.{{< /alert >}} | ||
| {{< alert type="warning" title="Warning" >}}This is a warning alert.{{< /alert >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| title: Blocks Cover and Link Down | ||
| linkTitle: Blocks Cover + Link Down | ||
| weight: 115 | ||
| description: Render the Docsy blocks/cover shortcode together with blocks/link-down. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< blocks/cover title="Docsy Cover Block" subtitle="Hero Example" color="dark" height="min" >}} | ||
| This cover block uses page resources named `background` and `logo`. | ||
|
|
||
| {{< blocks/link-down color="info" >}} | ||
| {{< /blocks/cover >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: Blocks Lead | ||
| linkTitle: Blocks Lead | ||
| weight: 120 | ||
| description: Render the Docsy blocks/lead shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< blocks/lead color="primary" height="min" >}} | ||
| This is a live `blocks/lead` example. | ||
| {{< /blocks/lead >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| title: Blocks Section and Feature | ||
| linkTitle: Blocks Section + Feature | ||
| weight: 125 | ||
| description: Render the Docsy blocks/section and blocks/feature shortcodes together. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< blocks/section color="light" type="container" >}} | ||
| {{< blocks/feature icon="fa-layer-group" title="Reusable" >}}Use shortcodes to compose reusable content patterns.{{< /blocks/feature >}} | ||
| {{< blocks/feature icon="fa-code" title="Declarative" >}}Keep formatting examples inside Markdown instead of hard-coding HTML everywhere.{{< /blocks/feature >}} | ||
| {{< blocks/feature icon="fa-book" title="Documented" >}}This page shows how each shortcode behaves when rendered.{{< /blocks/feature >}} | ||
| {{< /blocks/section >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: Card | ||
| linkTitle: Card | ||
| weight: 130 | ||
| description: Render the Docsy card shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{% card header="Docsy Card" title="Single card example" footer="Card footer" %}} | ||
| This is a rendered Docsy `card` shortcode. | ||
| {{% /card %}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: Cardpane | ||
| linkTitle: Cardpane | ||
| weight: 135 | ||
| description: Render the Docsy cardpane shortcode with nested cards. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{% cardpane %}} | ||
| {{% card header="Step 1" %}} | ||
| Install prerequisites. | ||
| {{% /card %}} | ||
| {{% card header="Step 2" %}} | ||
| Configure the environment. | ||
| {{% /card %}} | ||
| {{% card header="Step 3" %}} | ||
| Run the validation command. | ||
| {{% /card %}} | ||
| {{% /cardpane %}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: Chapterstyle | ||
| linkTitle: Chapterstyle | ||
| weight: 215 | ||
| description: Render the academy-theme chapterstyle shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{% chapterstyle style="padding: 1rem; border: 1px solid #d0d7de; border-radius: 0.75rem; background: #f8fafc;" %}} | ||
| This content is wrapped by the `chapterstyle` shortcode. | ||
| {{% /chapterstyle %}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| title: Code | ||
| linkTitle: Code | ||
| weight: 320 | ||
| description: Code block and inline code examples. | ||
| draft: true | ||
| --- | ||
|
|
||
| ```text | ||
| This is a code block. | ||
| ``` | ||
|
|
||
| Inline code like `var foo = "bar";` is supported. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: Collapsible | ||
| linkTitle: Collapsible | ||
| weight: 355 | ||
| description: Example of a collapsible details block. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< details summary="This is a collapsible title" >}} | ||
|
|
||
| This is the collapsed content. | ||
|
|
||
| It can be a list: | ||
|
|
||
| * First item | ||
| * Second item | ||
| {{< /details >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: Comment | ||
| linkTitle: Comment | ||
| weight: 140 | ||
| description: Render the Docsy comment shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| Visible text before the comment shortcode. {{< comment >}}This sentence is intentionally hidden by the Docsy `comment` shortcode.{{< /comment >}} Visible text after the comment shortcode. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: Conditional Text | ||
| linkTitle: Conditional Text | ||
| weight: 145 | ||
| description: Render the Docsy conditional-text shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< conditional-text include-if="examples" >}} | ||
| This sentence is rendered because `params.buildCondition` is set to `examples`. | ||
| {{< /conditional-text >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: CSV Table Roles | ||
| linkTitle: CSV Table Roles | ||
| weight: 225 | ||
| description: Render the academy-theme csvtable-roles shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< csvtable-roles >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: CSV Table | ||
| linkTitle: CSV Table | ||
| weight: 220 | ||
| description: Render the academy-theme csvtable shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< csvtable >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: Custom Organization Shortcode | ||
| linkTitle: Custom Org Shortcode | ||
| weight: 280 | ||
| description: Render the repository-local organization shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< 1e2a8e46-937c-47ea-ab43-5716e3bcab2e/custom-org-shortcode names="Exoscale Academy" >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: Docsy Alert | ||
| linkTitle: Docsy Alert | ||
| weight: 110 | ||
| description: Render the Docsy alert shortcode through the local demo alias. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< docsy-alert color="info" title="Docsy alert" >}}This block uses the Docsy implementation of the `alert` shortcode.{{< /docsy-alert >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: Docsy Pageinfo | ||
| linkTitle: Docsy Pageinfo | ||
| weight: 160 | ||
| description: Render the Docsy pageinfo shortcode through the local demo alias. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< docsy-pageinfo color="primary" >}}This block uses the Docsy implementation of `pageinfo`.{{< /docsy-pageinfo >}} |
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| title: Embedded Design | ||
| linkTitle: Embedded Design | ||
| weight: 340 | ||
| description: Example of the meshery-design-embed component shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| ```code | ||
| {{</* meshery-design-embed | ||
| id="embedded-design-c811e9f4-2522-4eb6-b775-7475545356d8" | ||
| src="/content-formatting-examples/embedded-design-deploy-meshery-using-meshery.js" | ||
| */>}} | ||
| ``` | ||
|
|
||
| The rendered output is shown below: | ||
|
|
||
| {{< meshery-design-embed | ||
| id="embedded-design-c811e9f4-2522-4eb6-b775-7475545356d8" | ||
| src="/content-formatting-examples/embedded-design-deploy-meshery-using-meshery.js" | ||
| >}} | ||
|
|
||
| Learn more about embedded designs: [Meshery design embedding documentation](https://docs.layer5.io/kanvas/designer/embedding-designs/). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: Figure | ||
| linkTitle: Figure | ||
| weight: 15 | ||
| description: Render the Hugo figure shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< figure src="/1e2a8e46-937c-47ea-ab43-5716e3bcab2e/images/exoscale-icon.png" alt="Exoscale icon" caption="A Hugo figure shortcode rendering a static image." >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: Footnotes | ||
| linkTitle: Footnotes | ||
| weight: 360 | ||
| description: Example of Markdown footnotes. | ||
| draft: true | ||
| --- | ||
|
|
||
| This is a superscript number for your footnote. [^1] | ||
|
|
||
| [^1]: This is a footnote. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: Highlight | ||
| linkTitle: Highlight | ||
| weight: 20 | ||
| description: Render the Hugo highlight shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{< highlight go "linenos=table,hl_lines=3" >}} | ||
| package main | ||
|
|
||
| import "fmt" | ||
|
|
||
| func main() { | ||
| fmt.Println("hello from the highlight shortcode") | ||
| } | ||
| {{< /highlight >}} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| title: Hugo Details | ||
| linkTitle: Hugo Details | ||
| weight: 10 | ||
| description: Render the Hugo built-in details shortcode. | ||
| draft: true | ||
| --- | ||
|
|
||
| {{% hugo-details summary="Hugo built-in details" open=true %}} | ||
| This content is rendered through the built-in Hugo `details` behavior. | ||
| {{% /hugo-details %}} |
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.
The
cleantarget now runsmake setupandmake site, which introduces network installs and starts a server as a side effect. That makesmake cleannon-obvious and harder to use in CI or scripting. Consider keepingcleanlimited to cleaning, and adding a separate target (e.g.,reset/rebuild) that chainsclean,setup, andsite.