diff --git a/content/content-formatting-examples/academy-theme/alerts.md b/content/content-formatting-examples/academy-theme/alerts/_index.md similarity index 100% rename from content/content-formatting-examples/academy-theme/alerts.md rename to content/content-formatting-examples/academy-theme/alerts/_index.md diff --git a/content/content-formatting-examples/academy-theme/chapterstyle.md b/content/content-formatting-examples/academy-theme/chapterstyle/_index.md similarity index 100% rename from content/content-formatting-examples/academy-theme/chapterstyle.md rename to content/content-formatting-examples/academy-theme/chapterstyle/_index.md diff --git a/content/content-formatting-examples/academy-theme/csvtable-roles.md b/content/content-formatting-examples/academy-theme/csvtable-roles/_index.md similarity index 92% rename from content/content-formatting-examples/academy-theme/csvtable-roles.md rename to content/content-formatting-examples/academy-theme/csvtable-roles/_index.md index d6642f512..59bb64f4e 100644 --- a/content/content-formatting-examples/academy-theme/csvtable-roles.md +++ b/content/content-formatting-examples/academy-theme/csvtable-roles/_index.md @@ -13,7 +13,3 @@ The `csvtable-roles` shortcode reads `static/data/csv/keys-backup.csv` and rende ``` The CSV file must be located at `static/data/csv/keys-backup.csv` with the same format used by `csvtable`. - -**Example:** - -{{< csvtable-roles >}} diff --git a/static/data/csv/keys-backup.csv b/content/content-formatting-examples/academy-theme/csvtable-roles/keys-backup.csv similarity index 100% rename from static/data/csv/keys-backup.csv rename to content/content-formatting-examples/academy-theme/csvtable-roles/keys-backup.csv diff --git a/content/content-formatting-examples/academy-theme/csvtable.md b/content/content-formatting-examples/academy-theme/csvtable/_index.md similarity index 94% rename from content/content-formatting-examples/academy-theme/csvtable.md rename to content/content-formatting-examples/academy-theme/csvtable/_index.md index 255c1dfeb..2e375afa6 100644 --- a/content/content-formatting-examples/academy-theme/csvtable.md +++ b/content/content-formatting-examples/academy-theme/csvtable/_index.md @@ -13,7 +13,3 @@ The `csvtable` shortcode reads `static/data/csv/keys-backup.csv` and renders a p ``` The CSV file must be located at `static/data/csv/keys-backup.csv` and contain columns for Category, Function, Feature, and various role names. - -**Example:** - -{{< csvtable >}} diff --git a/content/content-formatting-examples/academy-theme/csvtable/keys-backup.csv b/content/content-formatting-examples/academy-theme/csvtable/keys-backup.csv new file mode 100644 index 000000000..8e980d329 --- /dev/null +++ b/content/content-formatting-examples/academy-theme/csvtable/keys-backup.csv @@ -0,0 +1,10 @@ +Category,Function,Feature,Workspace Admin,Workspace Editor,Team Admin,Team Editor,Org Admin,Org Editor,Provider Admin,Keychain ID,Key ID,Inserted,Local Provider +Designs,Design,Create and edit cloud native designs,X,X,X,X,X,X,X,KC001,K001,2024-01-01,true +Designs,Design,Delete designs,X,,X,,X,,X,KC001,K002,2024-01-01,true +Designs,Design,Share designs with team,X,X,X,X,X,X,X,KC001,K003,2024-01-01,true +Environments,Environment,Create environments,X,X,X,,X,,X,KC002,K004,2024-01-15,true +Environments,Environment,Delete environments,X,,X,,X,,X,KC002,K005,2024-01-15,true +Environments,Environment,View environment details,X,X,X,X,X,X,X,KC002,K006,2024-01-15,true +Connections,Connection,Register connections,X,,X,,X,,X,KC003,K007,2024-02-01,true +Connections,Connection,Test connections,X,X,X,X,X,X,X,KC003,K008,2024-02-01,true +Connections,Connection,Delete connections,X,,X,,X,,X,KC003,K009,2024-02-01,true diff --git a/content/content-formatting-examples/academy-theme/image.md b/content/content-formatting-examples/academy-theme/image.md deleted file mode 100644 index 7cb4b8cab..000000000 --- a/content/content-formatting-examples/academy-theme/image.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Image -linkTitle: Image -weight: 6 -description: Render the academy-theme image shortcode. -draft: true ---- - -```text -{{}} -``` - -**Example:** - -{{< image src="/examples/images/exoscale-icon.png" alt="Exoscale icon displayed with the academy-theme image shortcode" title="Theme image shortcode" width="140px" radius="12%" >}} diff --git a/content/content-formatting-examples/academy-theme/image/_index.md b/content/content-formatting-examples/academy-theme/image/_index.md new file mode 100644 index 000000000..19ad8dde4 --- /dev/null +++ b/content/content-formatting-examples/academy-theme/image/_index.md @@ -0,0 +1,15 @@ +--- +title: Image +linkTitle: Image +weight: 6 +description: Render the academy-theme image shortcode. +draft: true +--- + +```text +{{}} +``` + +**Example:** + +{{< image src="exoscale-icon.png" alt="Exoscale icon displayed with the academy-theme image shortcode" title="Theme image shortcode" width="140px" radius="12%" >}} diff --git a/static/examples/images/exoscale-icon.png b/content/content-formatting-examples/academy-theme/image/exoscale-icon.png similarity index 100% rename from static/examples/images/exoscale-icon.png rename to content/content-formatting-examples/academy-theme/image/exoscale-icon.png diff --git a/content/content-formatting-examples/academy-theme/lab-intro.md b/content/content-formatting-examples/academy-theme/lab-intro/_index.md similarity index 100% rename from content/content-formatting-examples/academy-theme/lab-intro.md rename to content/content-formatting-examples/academy-theme/lab-intro/_index.md diff --git a/content/content-formatting-examples/academy-theme/local-video.md b/content/content-formatting-examples/academy-theme/local-video/_index.md similarity index 100% rename from content/content-formatting-examples/academy-theme/local-video.md rename to content/content-formatting-examples/academy-theme/local-video/_index.md diff --git a/content/content-formatting-examples/academy-theme/meshery-design-embed/index.md b/content/content-formatting-examples/academy-theme/meshery-design-embed/_index.md similarity index 84% rename from content/content-formatting-examples/academy-theme/meshery-design-embed/index.md rename to content/content-formatting-examples/academy-theme/meshery-design-embed/_index.md index 41083bc6c..403853d0b 100644 --- a/content/content-formatting-examples/academy-theme/meshery-design-embed/index.md +++ b/content/content-formatting-examples/academy-theme/meshery-design-embed/_index.md @@ -17,9 +17,12 @@ The `meshery-design-embed` shortcode renders an interactive Meshery design diagr The rendered output is shown below: +**Example:** + {{< meshery-design-embed id="embedded-design-c811e9f4-2522-4eb6-b775-7475545356d8" src="./embedded-design-deploy-meshery-using-meshery.js" >}} -[Learn more](https://docs.layer5.io/kanvas/designer/embedding-designs/) about embedded designs. \ No newline at end of file + +> [Learn more](https://docs.layer5.io/kanvas/designer/embedding-designs/) about embedded designs. \ No newline at end of file diff --git a/content/content-formatting-examples/academy-theme/org-id.md b/content/content-formatting-examples/academy-theme/org-id/_index.md similarity index 100% rename from content/content-formatting-examples/academy-theme/org-id.md rename to content/content-formatting-examples/academy-theme/org-id/_index.md diff --git a/content/content-formatting-examples/academy-theme/svg.md b/content/content-formatting-examples/academy-theme/svg/_index.md similarity index 88% rename from content/content-formatting-examples/academy-theme/svg.md rename to content/content-formatting-examples/academy-theme/svg/_index.md index 4ad3f55a1..40f21a483 100644 --- a/content/content-formatting-examples/academy-theme/svg.md +++ b/content/content-formatting-examples/academy-theme/svg/_index.md @@ -20,6 +20,6 @@ The `svg` shortcode renders an inline SVG icon from `assets/icons/{name}.svg`. **Example:** -The icon renders inline: {{< svg name="exoscale-icon" >}} + To add your own SVG icons, place `.svg` files in the `assets/icons/` directory. diff --git a/assets/icons/exoscale-icon.svg b/content/content-formatting-examples/academy-theme/svg/exoscale-icon.svg similarity index 100% rename from assets/icons/exoscale-icon.svg rename to content/content-formatting-examples/academy-theme/svg/exoscale-icon.svg diff --git a/content/content-formatting-examples/academy-theme/theme-details.md b/content/content-formatting-examples/academy-theme/theme-details/_index.md similarity index 100% rename from content/content-formatting-examples/academy-theme/theme-details.md rename to content/content-formatting-examples/academy-theme/theme-details/_index.md diff --git a/content/content-formatting-examples/academy-theme/theme-pageinfo.md b/content/content-formatting-examples/academy-theme/theme-pageinfo/_index.md similarity index 100% rename from content/content-formatting-examples/academy-theme/theme-pageinfo.md rename to content/content-formatting-examples/academy-theme/theme-pageinfo/_index.md diff --git a/content/content-formatting-examples/academy-theme/usestatic.md b/content/content-formatting-examples/academy-theme/usestatic/_index.md similarity index 68% rename from content/content-formatting-examples/academy-theme/usestatic.md rename to content/content-formatting-examples/academy-theme/usestatic/_index.md index 2d16b5d34..524f0a773 100644 --- a/content/content-formatting-examples/academy-theme/usestatic.md +++ b/content/content-formatting-examples/academy-theme/usestatic/_index.md @@ -9,7 +9,7 @@ draft: true The `usestatic` shortcode resolves a tenant-scoped static file path, prefixing it with the organization UUID configured in `params.defined_org`. ```text -{{}} +{{}} ``` -Resolved tenant-scoped static path: {{< usestatic "images/exoscale-icon.png" >}} +Resolved tenant-scoped static path: {{< usestatic "./exoscale-icon.png" >}} diff --git a/content/content-formatting-examples/academy-theme/usestatic/exoscale-icon.png b/content/content-formatting-examples/academy-theme/usestatic/exoscale-icon.png new file mode 100644 index 000000000..d2f02a0f7 Binary files /dev/null and b/content/content-formatting-examples/academy-theme/usestatic/exoscale-icon.png differ diff --git a/content/content-formatting-examples/academy-theme/version.md b/content/content-formatting-examples/academy-theme/version/_index.md similarity index 100% rename from content/content-formatting-examples/academy-theme/version.md rename to content/content-formatting-examples/academy-theme/version/_index.md diff --git a/content/content-formatting-examples/docsy/blocks-cover-link-down/index.md b/content/content-formatting-examples/docsy/blocks-cover-link-down/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/blocks-cover-link-down/index.md rename to content/content-formatting-examples/docsy/blocks-cover-link-down/_index.md diff --git a/content/content-formatting-examples/docsy/blocks-lead.md b/content/content-formatting-examples/docsy/blocks-lead/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/blocks-lead.md rename to content/content-formatting-examples/docsy/blocks-lead/_index.md diff --git a/content/content-formatting-examples/docsy/blocks-section-feature.md b/content/content-formatting-examples/docsy/blocks-section-feature/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/blocks-section-feature.md rename to content/content-formatting-examples/docsy/blocks-section-feature/_index.md diff --git a/content/content-formatting-examples/docsy/card.md b/content/content-formatting-examples/docsy/card/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/card.md rename to content/content-formatting-examples/docsy/card/_index.md diff --git a/content/content-formatting-examples/docsy/cardpane.md b/content/content-formatting-examples/docsy/cardpane/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/cardpane.md rename to content/content-formatting-examples/docsy/cardpane/_index.md diff --git a/content/content-formatting-examples/docsy/comment.md b/content/content-formatting-examples/docsy/comment/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/comment.md rename to content/content-formatting-examples/docsy/comment/_index.md diff --git a/content/content-formatting-examples/docsy/conditional-text.md b/content/content-formatting-examples/docsy/conditional-text/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/conditional-text.md rename to content/content-formatting-examples/docsy/conditional-text/_index.md diff --git a/content/content-formatting-examples/docsy/docsy-alert.md b/content/content-formatting-examples/docsy/docsy-alert/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/docsy-alert.md rename to content/content-formatting-examples/docsy/docsy-alert/_index.md diff --git a/content/content-formatting-examples/docsy/docsy-pageinfo.md b/content/content-formatting-examples/docsy/docsy-pageinfo/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/docsy-pageinfo.md rename to content/content-formatting-examples/docsy/docsy-pageinfo/_index.md diff --git a/content/content-formatting-examples/docsy/iframe.md b/content/content-formatting-examples/docsy/iframe.md deleted file mode 100644 index efe50ecc1..000000000 --- a/content/content-formatting-examples/docsy/iframe.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Iframe -linkTitle: Iframe -weight: 8 -description: Render the Docsy iframe shortcode. -draft: true ---- - -```text -{{}} -``` - -**Example:** - -{{< iframe src="/examples/frame-example.html" style="min-height: 18rem; border: 1px solid #d0d7de; border-radius: 0.75rem;" >}} diff --git a/content/content-formatting-examples/docsy/iframe/_index.md b/content/content-formatting-examples/docsy/iframe/_index.md new file mode 100644 index 000000000..5fd95732d --- /dev/null +++ b/content/content-formatting-examples/docsy/iframe/_index.md @@ -0,0 +1,15 @@ +--- +title: Iframe +linkTitle: Iframe +weight: 8 +description: Render the Docsy iframe shortcode. +draft: true +--- + +```text +{{}} +``` + +**Example:** + +```{{}}``` diff --git a/static/examples/frame-example.html b/content/content-formatting-examples/docsy/iframe/frame-example.html similarity index 100% rename from static/examples/frame-example.html rename to content/content-formatting-examples/docsy/iframe/frame-example.html diff --git a/content/content-formatting-examples/docsy/imgproc/index.md b/content/content-formatting-examples/docsy/imgproc/_index.md similarity index 100% rename from content/content-formatting-examples/docsy/imgproc/index.md rename to content/content-formatting-examples/docsy/imgproc/_index.md diff --git a/content/content-formatting-examples/docsy/readfile.md b/content/content-formatting-examples/docsy/readfile/_index.md similarity index 59% rename from content/content-formatting-examples/docsy/readfile.md rename to content/content-formatting-examples/docsy/readfile/_index.md index 8cf60a5f8..4cf925fc8 100644 --- a/content/content-formatting-examples/docsy/readfile.md +++ b/content/content-formatting-examples/docsy/readfile/_index.md @@ -9,7 +9,7 @@ draft: true The `readfile` shortcode includes the contents of a file inline. When `code="true"` is set, the contents are rendered inside a code block. ```text -{{}} +{{}} ``` -{{< readfile file="/static/examples/openapi/example.json" code="true" lang="json" >}} +{{< readfile file="example.json" code="true" lang="json" >}} diff --git a/static/examples/openapi/example.json b/content/content-formatting-examples/docsy/readfile/example.json similarity index 100% rename from static/examples/openapi/example.json rename to content/content-formatting-examples/docsy/readfile/example.json diff --git a/content/content-formatting-examples/docsy/redoc.md b/content/content-formatting-examples/docsy/redoc/_index.md similarity index 58% rename from content/content-formatting-examples/docsy/redoc.md rename to content/content-formatting-examples/docsy/redoc/_index.md index 1217a3ad4..4dc05fb90 100644 --- a/content/content-formatting-examples/docsy/redoc.md +++ b/content/content-formatting-examples/docsy/redoc/_index.md @@ -7,9 +7,9 @@ draft: true --- ```text -{{}} +{{}} ``` **Example:** -{{< redoc "examples/openapi/example.json" >}} +{{< redoc "example.json" >}} diff --git a/content/content-formatting-examples/docsy/redoc/example.json b/content/content-formatting-examples/docsy/redoc/example.json new file mode 100644 index 000000000..0bc24d96b --- /dev/null +++ b/content/content-formatting-examples/docsy/redoc/example.json @@ -0,0 +1,69 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Example Academy API", + "version": "1.0.0", + "description": "A sample API specification for demonstrating the Redoc and SwaggerUI shortcodes." + }, + "paths": { + "/api/courses": { + "get": { + "summary": "List courses", + "description": "Returns a list of all available courses.", + "responses": { + "200": { + "description": "A list of courses.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Course" + } + } + } + } + } + } + } + }, + "/api/courses/{id}": { + "get": { + "summary": "Get a course", + "description": "Returns a single course by ID.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "A course object.", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Course" } + } + } + }, + "404": { "description": "Course not found." } + } + } + } + }, + "components": { + "schemas": { + "Course": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "cloud-101" }, + "title": { "type": "string", "example": "Cloud Fundamentals" }, + "description": { "type": "string", "example": "An introduction to cloud computing concepts." }, + "duration": { "type": "string", "example": "2 hours" } + } + } + } + } +} diff --git a/content/content-formatting-examples/docsy/swaggerui.md b/content/content-formatting-examples/docsy/swaggerui/_index.md similarity index 50% rename from content/content-formatting-examples/docsy/swaggerui.md rename to content/content-formatting-examples/docsy/swaggerui/_index.md index 84c0826e5..92d409011 100644 --- a/content/content-formatting-examples/docsy/swaggerui.md +++ b/content/content-formatting-examples/docsy/swaggerui/_index.md @@ -4,13 +4,12 @@ linkTitle: SwaggerUI weight: 11 description: Render the Docsy swaggerui shortcode. draft: true -type: swagger --- ```text -{{}} +{{}} ``` **Example:** -{{< swaggerui src="/academy/examples/openapi/example.json" >}} +{{< swaggerui src="example.json" >}} diff --git a/content/content-formatting-examples/docsy/swaggerui/example.json b/content/content-formatting-examples/docsy/swaggerui/example.json new file mode 100644 index 000000000..0bc24d96b --- /dev/null +++ b/content/content-formatting-examples/docsy/swaggerui/example.json @@ -0,0 +1,69 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Example Academy API", + "version": "1.0.0", + "description": "A sample API specification for demonstrating the Redoc and SwaggerUI shortcodes." + }, + "paths": { + "/api/courses": { + "get": { + "summary": "List courses", + "description": "Returns a list of all available courses.", + "responses": { + "200": { + "description": "A list of courses.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Course" + } + } + } + } + } + } + } + }, + "/api/courses/{id}": { + "get": { + "summary": "Get a course", + "description": "Returns a single course by ID.", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "A course object.", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/Course" } + } + } + }, + "404": { "description": "Course not found." } + } + } + } + }, + "components": { + "schemas": { + "Course": { + "type": "object", + "properties": { + "id": { "type": "string", "example": "cloud-101" }, + "title": { "type": "string", "example": "Cloud Fundamentals" }, + "description": { "type": "string", "example": "An introduction to cloud computing concepts." }, + "duration": { "type": "string", "example": "2 hours" } + } + } + } + } +} diff --git a/content/content-formatting-examples/docsy/tabpane-tab.md b/content/content-formatting-examples/docsy/tabpane-tab/_index.md similarity index 90% rename from content/content-formatting-examples/docsy/tabpane-tab.md rename to content/content-formatting-examples/docsy/tabpane-tab/_index.md index f64e07b66..1460082eb 100644 --- a/content/content-formatting-examples/docsy/tabpane-tab.md +++ b/content/content-formatting-examples/docsy/tabpane-tab/_index.md @@ -22,7 +22,7 @@ This is the first rendered tab. {{< /tab >}} {{% tab header="Image" lang="en" %}} -![Rendered tab image](/examples/images/exoscale-icon.png) +![Rendered tab image](exoscale-icon.png) {{< /tab >}} {{< /tabpane >}} diff --git a/content/content-formatting-examples/docsy/tabpane-tab/exoscale-icon.png b/content/content-formatting-examples/docsy/tabpane-tab/exoscale-icon.png new file mode 100644 index 000000000..d2f02a0f7 Binary files /dev/null and b/content/content-formatting-examples/docsy/tabpane-tab/exoscale-icon.png differ diff --git a/content/content-formatting-examples/docsy/tabpanel.md b/content/content-formatting-examples/docsy/tabpanel/_index.md similarity index 91% rename from content/content-formatting-examples/docsy/tabpanel.md rename to content/content-formatting-examples/docsy/tabpanel/_index.md index ec351702c..931369ed8 100644 --- a/content/content-formatting-examples/docsy/tabpanel.md +++ b/content/content-formatting-examples/docsy/tabpanel/_index.md @@ -43,7 +43,7 @@ Tabs help organize related content. Here is an example image: -![Spruce shoot example image](/academy/examples/images/layer5-academy-icon.svg) +![Spruce shoot example image](layer5-academy-icon.svg) {{< /tab >}} diff --git a/static/examples/images/layer5-academy-icon.svg b/content/content-formatting-examples/docsy/tabpanel/layer5-academy-icon.svg similarity index 100% rename from static/examples/images/layer5-academy-icon.svg rename to content/content-formatting-examples/docsy/tabpanel/layer5-academy-icon.svg diff --git a/content/content-formatting-examples/hextra/asciinema/index.md b/content/content-formatting-examples/hextra/asciinema/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/asciinema/index.md rename to content/content-formatting-examples/hextra/asciinema/_index.md diff --git a/content/content-formatting-examples/hextra/badge.md b/content/content-formatting-examples/hextra/badge/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/badge.md rename to content/content-formatting-examples/hextra/badge/_index.md diff --git a/content/content-formatting-examples/hextra/callout.md b/content/content-formatting-examples/hextra/callout/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/callout.md rename to content/content-formatting-examples/hextra/callout/_index.md diff --git a/content/content-formatting-examples/hextra/cards.md b/content/content-formatting-examples/hextra/cards/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/cards.md rename to content/content-formatting-examples/hextra/cards/_index.md diff --git a/content/content-formatting-examples/hextra/details.md b/content/content-formatting-examples/hextra/details/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/details.md rename to content/content-formatting-examples/hextra/details/_index.md diff --git a/content/content-formatting-examples/hextra/filetree.md b/content/content-formatting-examples/hextra/filetree/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/filetree.md rename to content/content-formatting-examples/hextra/filetree/_index.md diff --git a/content/content-formatting-examples/hextra/icon.md b/content/content-formatting-examples/hextra/icon/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/icon.md rename to content/content-formatting-examples/hextra/icon/_index.md diff --git a/content/content-formatting-examples/hextra/include.md b/content/content-formatting-examples/hextra/include/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/include.md rename to content/content-formatting-examples/hextra/include/_index.md diff --git a/content/content-formatting-examples/hextra/jupyter/index.md b/content/content-formatting-examples/hextra/jupyter/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/jupyter/index.md rename to content/content-formatting-examples/hextra/jupyter/_index.md diff --git a/content/content-formatting-examples/hextra/pdf/index.md b/content/content-formatting-examples/hextra/pdf/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/pdf/index.md rename to content/content-formatting-examples/hextra/pdf/_index.md diff --git a/content/content-formatting-examples/hextra/steps.md b/content/content-formatting-examples/hextra/steps/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/steps.md rename to content/content-formatting-examples/hextra/steps/_index.md diff --git a/content/content-formatting-examples/hextra/tabs.md b/content/content-formatting-examples/hextra/tabs/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/tabs.md rename to content/content-formatting-examples/hextra/tabs/_index.md diff --git a/content/content-formatting-examples/hextra/term.md b/content/content-formatting-examples/hextra/term/_index.md similarity index 100% rename from content/content-formatting-examples/hextra/term.md rename to content/content-formatting-examples/hextra/term/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/figure.md b/content/content-formatting-examples/hugo-builtins/figure.md deleted file mode 100644 index 7b9c61634..000000000 --- a/content/content-formatting-examples/hugo-builtins/figure.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Figure -linkTitle: Figure -weight: 1 -description: Render the Hugo figure shortcode. -draft: true ---- - -```text -{{}} -``` - -**Example:** - -{{< figure src="/examples/images/exoscale-icon.png" alt="Exoscale icon" caption="A Hugo figure shortcode rendering a static image." >}} diff --git a/content/content-formatting-examples/hugo-builtins/figure/_index.md b/content/content-formatting-examples/hugo-builtins/figure/_index.md new file mode 100644 index 000000000..af784c12b --- /dev/null +++ b/content/content-formatting-examples/hugo-builtins/figure/_index.md @@ -0,0 +1,15 @@ +--- +title: Figure +linkTitle: Figure +weight: 1 +description: Render the Hugo figure shortcode. +draft: true +--- + +```text +{{}} +``` + +**Example:** + +{{< figure src="exoscale-icon.png" alt="Exoscale icon" caption="A Hugo figure shortcode rendering a static image." >}} diff --git a/content/content-formatting-examples/hugo-builtins/figure/exoscale-icon.png b/content/content-formatting-examples/hugo-builtins/figure/exoscale-icon.png new file mode 100644 index 000000000..d2f02a0f7 Binary files /dev/null and b/content/content-formatting-examples/hugo-builtins/figure/exoscale-icon.png differ diff --git a/content/content-formatting-examples/hugo-builtins/highlight.md b/content/content-formatting-examples/hugo-builtins/hightlight/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/highlight.md rename to content/content-formatting-examples/hugo-builtins/hightlight/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/hugo-details.md b/content/content-formatting-examples/hugo-builtins/hugo-details/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/hugo-details.md rename to content/content-formatting-examples/hugo-builtins/hugo-details/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/instagram.md b/content/content-formatting-examples/hugo-builtins/instagram/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/instagram.md rename to content/content-formatting-examples/hugo-builtins/instagram/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/param.md b/content/content-formatting-examples/hugo-builtins/param/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/param.md rename to content/content-formatting-examples/hugo-builtins/param/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/qr.md b/content/content-formatting-examples/hugo-builtins/qr/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/qr.md rename to content/content-formatting-examples/hugo-builtins/qr/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/ref.md b/content/content-formatting-examples/hugo-builtins/ref/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/ref.md rename to content/content-formatting-examples/hugo-builtins/ref/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/relref.md b/content/content-formatting-examples/hugo-builtins/relref/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/relref.md rename to content/content-formatting-examples/hugo-builtins/relref/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/vimeo.md b/content/content-formatting-examples/hugo-builtins/vimeo/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/vimeo.md rename to content/content-formatting-examples/hugo-builtins/vimeo/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/x.md b/content/content-formatting-examples/hugo-builtins/x/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/x.md rename to content/content-formatting-examples/hugo-builtins/x/_index.md diff --git a/content/content-formatting-examples/hugo-builtins/youtube.md b/content/content-formatting-examples/hugo-builtins/youtube/_index.md similarity index 100% rename from content/content-formatting-examples/hugo-builtins/youtube.md rename to content/content-formatting-examples/hugo-builtins/youtube/_index.md diff --git a/content/content-formatting-examples/markdown/code.md b/content/content-formatting-examples/markdown/code/_index.md similarity index 100% rename from content/content-formatting-examples/markdown/code.md rename to content/content-formatting-examples/markdown/code/_index.md diff --git a/content/content-formatting-examples/markdown/footnotes.md b/content/content-formatting-examples/markdown/footnotes/_index.md similarity index 100% rename from content/content-formatting-examples/markdown/footnotes.md rename to content/content-formatting-examples/markdown/footnotes/_index.md diff --git a/content/content-formatting-examples/markdown/image-styling.md b/content/content-formatting-examples/markdown/image-styling/_index.md similarity index 100% rename from content/content-formatting-examples/markdown/image-styling.md rename to content/content-formatting-examples/markdown/image-styling/_index.md diff --git a/content/content-formatting-examples/markdown/lists.md b/content/content-formatting-examples/markdown/lists/_index.md similarity index 100% rename from content/content-formatting-examples/markdown/lists.md rename to content/content-formatting-examples/markdown/lists/_index.md diff --git a/content/content-formatting-examples/markdown/markdown-basics.md b/content/content-formatting-examples/markdown/markdown-basics/_index.md similarity index 100% rename from content/content-formatting-examples/markdown/markdown-basics.md rename to content/content-formatting-examples/markdown/markdown-basics/_index.md diff --git a/content/content-formatting-examples/markdown/responsive-images.md b/content/content-formatting-examples/markdown/responsive-images/_index.md similarity index 51% rename from content/content-formatting-examples/markdown/responsive-images.md rename to content/content-formatting-examples/markdown/responsive-images/_index.md index 684a460ac..050b74030 100644 --- a/content/content-formatting-examples/markdown/responsive-images.md +++ b/content/content-formatting-examples/markdown/responsive-images/_index.md @@ -8,10 +8,8 @@ draft: true Small images should be shown at their actual size. -![Spruce shoot close-up](/academy/assets/icons/layer5-academy-icon.svg) +![Spruce shoot close-up](deploy.png) Large images should always scale down and fit in the content container. -![Large spruce shoot photo](/academy/assets/icons/layer5-academy-icon.svg) - -_The photo above of the Spruce Picea abies shoot with foliage buds: Bjørn Erik Pedersen, CC-BY-SA._ +![Large spruce shoot photo](kubernetes-icon.svg) diff --git a/static/examples/images/deploy.png b/content/content-formatting-examples/markdown/responsive-images/deploy.png similarity index 100% rename from static/examples/images/deploy.png rename to content/content-formatting-examples/markdown/responsive-images/deploy.png diff --git a/static/examples/images/kubernetes-icon.svg b/content/content-formatting-examples/markdown/responsive-images/kubernetes-icon.svg similarity index 100% rename from static/examples/images/kubernetes-icon.svg rename to content/content-formatting-examples/markdown/responsive-images/kubernetes-icon.svg diff --git a/content/content-formatting-examples/markdown/tables.md b/content/content-formatting-examples/markdown/tables/_index.md similarity index 100% rename from content/content-formatting-examples/markdown/tables.md rename to content/content-formatting-examples/markdown/tables/_index.md diff --git a/static/examples/images/exoscale-icon.svg b/static/examples/images/exoscale-icon.svg deleted file mode 100644 index e68645e2e..000000000 --- a/static/examples/images/exoscale-icon.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file