Documentation
My goal is to make it approachable for newcomers to Hugo, while still keeping it efficient for more experienced users.
Contents
Support Alpha
From translations and bug reports to feedback or sponsorship, it all helps.
Change the FAB position
Open the OCD console
Check for alpha and hugo updates
Set ocd_enabled=false in the `params.toml` config file.
You're using the latest version of the Alpha theme.
You're using the latest version of Hugo.
A new version of the Alpha theme is available!
A new version of Hugo is available!
The title in hugo.toml, is missing.
Please add the name of your website as the title.
Example: title = "My Website"
The languageName key is missing for one of the languages in language.toml.
Please define a language name in the languageName key.
Example: languageName = "English"
The established_year value, in /config/params.toml, is set to 2025 which is a future year.
Please change it to 2025 or an earlier year.
Example: established_year = "2025"
The established_year value, in /config/params.toml, is set to 2025 which is not a valid year.
Please change it to a valid year value.
Example: established_year = "2025"
Please enter a title in the frontmatter of the page above.
Example: title = "The page title"
Please enter a short description in the frontmatter of the page above.
Example: description = "The page description"
Verify that the image is placed inside the page bundle (i.e. the same folder as the index.md) and that the filename in your Markdown match.
Example:
Image in the page bundle:
/content/posts/post-1/
├── index.md
└── image.jpg
Markdown image:

Please enter an image description (alt text) in your Markdown image instruction.
Example: 
Please change the STYLE value of the shortcode {{< num-list >}} to one of:
Example: {{< num-list STYLE="pill" >}}
Please delete the invalid parameters from the shortcode {{< num-list >}}.
Accepted parameters:
Example: {{< num-list STYLE="card" TITLE="Example title" LIMIT="5" >}}
Please delete the invalid parameters from the shortcode {{< text-snippet >}}{{< /text-snippet >}}.
Accepted parameter:
Example: {{< text-snippet TITLE="Example title" >}} markdown text content {{< /text-snippet >}}
Please delete the invalid parameters from the shortcode {{< hero >}}.
Accepted parameter:
Example:
{{< hero
TITLE="Example title"
SUBTITLE="Example subtitle"
BTN-TEXT="Example button text"
BTN-LINK="https://example.com/page-1"
BTN-LABEL="Example button aria-label"
LINK-TEXT="Example link text"
LINK="https://example.com/page-2"
LINK-LABEL="Example link aria-label"
>}}
Please fill the missing parameter BTN-TEXT from the shortcode {{< hero >}}.
Example: BTN-TEXT="Example button text"
BTN-LINK="https://example.com/page-1"
Please fill the missing parameter LINK-TEXT from the shortcode {{< hero >}}.
Example: LINK-TEXT="Example button text"
LINK="https://example.com/page-1"
Please change the TYPE value of the shortcode {{< status-card >}} to one of:
Example: {{< status-card TITLE="Example title" TYPE="info" >}} Example text {{< /status-card >}}
Please delete the invalid parameters from the shortcode {{< status-card >}}.
Accepted parameter:
Example: {{< status-card TITLE="Example title" TYPE="warning" >}} markdown text content {{< /status-card >}}
Please delete the invalid parameters from the shortcode {{< cta >}}.
Accepted parameter:
Example:
{{< cta
TITLE="Example title"
BTN-TEXT="Example button text"
BTN-LINK="https://example.com/page-1"
BTN-LABEL="Example button aria-label"
>}}
Markdown text content
{{< /cta >}}
Please fill the missing parameter BTN-TEXT from the shortcode {{< cta >}}.
Example: BTN-TEXT="Example button text"
BTN-LINK="https://example.com/page-1"
Please delete the invalid parameters from the shortcode {{< faq >}}.
Accepted parameter:
Example:
{{< cta TITLE="Example title" SUBTITLE="Example subtitle" >}}
## Question 1
Answer 1
## Question 2
Answer 2
{{< /cta >}}
Please delete the invalid parameters from the shortcode {{< about >}}.
Accepted parameter:
Example:
{{< about AUTHOR="Username" AVATAR="filename.jpg" >}}
/.. About author text ../
{{< /about >}}
The parameter AVATAR is set for the shortcode {{< about >}}, but the image file is missing.
Please ensure that:
AVATAR="filename.jpg" (shortcode parameter)
/assets/img/filename.jpg (file location)
Please delete the invalid parameters from the shortcode {{< social >}}.
Accepted parameter:
Example:
{{< social NUMBER="3" >}}
To use the {{< social >}} shortcode, you need to define a sc_social menu in your configuration.
Example:
[[sc_social]]
name = 'Github'
url = 'https://github.com/username'
pre = '#github'
weight = 10
For detailed instructions on creating menus, see the Alpha theme menu documentation.
Invalid parameter value for the {{< social >}} shortcode.
The NUMBER parameter must be an integer (whole number).
Example:
NUMBER="5"