Docsy Shortcodes on Exoscale Academy

Alert (Docsy)

Mon, 01 Jan 0001 00:00:00 +0000

The Docsy alert shortcode renders a colored alert box. The academy-theme overrides this shortcode, so invoking alert will use the academy-theme implementation. This page demonstrates the Docsy color parameter syntax.

{{< alert color="info" title="Info alert" >}}Alert content here.{{< /alert >}}

Parameters:

Parameter	Description	Default
`color`	Bootstrap color: `primary`, `secondary`, `success`, `danger`, `warning`, `info`	(none)
`title`	Optional title text	(none)

Example:

Docsy alert

This block uses the Docsy-style color parameter.

Pageinfo (Docsy)

Mon, 01 Jan 0001 00:00:00 +0000

The Docsy pageinfo shortcode renders a colored page-level info box. The academy-theme overrides this shortcode.

{{< pageinfo color="primary" >}}Notice content here.{{< /pageinfo >}}

Parameters:

Parameter	Description	Default
`color`	Bootstrap color name	(none)

Example:

This block uses the Docsy implementation of `pageinfo` with `color="primary"`.

Blocks Cover and Link Down

Mon, 01 Jan 0001 00:00:00 +0000

{{< blocks/cover title="Cover Title" subtitle="Subtitle" color="dark" height="min" >}}
Cover content here.
{{< blocks/link-down color="info" >}}
{{< /blocks/cover >}}

Example:

Docsy Cover Block

Hero Example

This cover block uses page resources named background and logo.

Blocks Lead

Mon, 01 Jan 0001 00:00:00 +0000

{{< blocks/lead color="primary" height="min" >}}
Lead section content here.
{{< /blocks/lead >}}

Example:

This is a live `blocks/lead` example.

Blocks Section and Feature

Mon, 01 Jan 0001 00:00:00 +0000

{{< blocks/section color="light" type="container" >}}
 {{< blocks/feature icon="fa-layer-group" title="Title" >}}Description.{{< /blocks/feature >}}
{{< /blocks/section >}}

Example:

Reusable

Use shortcodes to compose reusable content patterns.

Declarative

Keep formatting examples inside Markdown instead of hard-coding HTML everywhere.

Documented

This page shows how each shortcode behaves when rendered.

Comment

Mon, 01 Jan 0001 00:00:00 +0000

The comment shortcode hides content from the rendered output. It acts as an invisible annotation — useful for leaving notes in Markdown that readers won’t see.

{{< comment >}}This text is hidden from the rendered page.{{< /comment >}}

Example:

Visible text before the comment. Visible text after the comment.

The text between the comment shortcode tags above is not rendered. View the page source to confirm.

Card

Mon, 01 Jan 0001 00:00:00 +0000

{{% card header="Card Header" title="Card title" footer="Card footer" %}}
Card body content here.
{{% /card %}}

Example:

This is a rendered Docsy card shortcode.

Conditional Text

Mon, 01 Jan 0001 00:00:00 +0000

The conditional-text shortcode renders content only when the include-if value matches the site’s params.buildCondition. This is useful for showing content specific to certain build environments or feature flags.

{{< conditional-text include-if="examples" >}}
This text only appears when buildCondition is set to "examples".
{{< /conditional-text >}}

Parameters:

Parameter	Description	Default
`include-if`	Condition string to match against `params.buildCondition`	(required)

Example:

This sentence is rendered because `params.buildCondition` is set to `examples`.

If the text above is not visible, the site’s params.buildCondition does not match "examples".

Cardpane

Mon, 01 Jan 0001 00:00:00 +0000

{{% cardpane %}}
 {{% card header="Step 1" %}}First card content.{{% /card %}}
 {{% card header="Step 2" %}}Second card content.{{% /card %}}
{{% /cardpane %}}

Example:

Iframe

Mon, 01 Jan 0001 00:00:00 +0000

{{< iframe src="/examples/frame-example.html" style="min-height: 18rem;" >}}

Example:

Your browser can not display embedded frames. You can access the embedded page via the following link: /examples/frame-example.html

Imgproc

Mon, 01 Jan 0001 00:00:00 +0000

This image was processed from a page resource using the Docsy `imgproc` shortcode.

Readfile

Mon, 01 Jan 0001 00:00:00 +0000

The readfile shortcode includes the contents of a file inline. When code="true" is set, the contents are rendered inside a code block.

{{< readfile file="/static/examples/openapi/example.json" code="true" lang="json" >}}

{
 "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" }
 }
 }
 }
 }
}

Redoc

Mon, 01 Jan 0001 00:00:00 +0000

SwaggerUI

Mon, 01 Jan 0001 00:00:00 +0000

Tabpane and Tab

Mon, 01 Jan 0001 00:00:00 +0000

This is the first rendered tab.

TabPanel

Mon, 01 Jan 0001 00:00:00 +0000

Tabs help organize related content.

Concise explanation
Another brief point

Tabs help organize related content.

Concise explanation
Another brief point

Here is an example image: