Metadata Configuration

Info

This documentation is AI-generated. You can help improve it by submitting an Issue.

提示

After your site has installed the latest version of the theme, you can fill in your site link below.
This will enable quick jump links in this documentation.

Site Link

Example

🎯 Purpose

Explains the purpose of the configuration item.

📂 Configuration Item Location

Explains the location in the theme configuration.

⚡ Quick Jump

Click to quickly jump to the corresponding theme configuration item.

🏷️ Type

The value type of this configuration item.

Here are some common types

• String: A sequence of characters, such as abc123, zh-CN.
• Integer: Whole numbers, such as -1, 0, 100.
• Float: Numbers with decimal points, such as 1.2, 0.3, 4.5.
• Boolean: true or false. In actual configuration items, it appears as a switch, on is true, off is false.
• Option: Fixed options are provided, just select directly.
• Repeater: Can repeat a group of inputs. Can add groups, remove groups, swap order of any groups.
• Code input box (programming language): Provides a multi-line code input box, which will be highlighted according to the specified programming language.
• Attachment: Select uploaded attachments.
• Icon: Use the icon setting box provided by Halo CMS, where you can select any iconify icon.

⭐ Default Value

The default value of this configuration item.

How to reset all configurations to default values?

Go to /console/theme, then click the three dots on the far right of the theme name row, and finally click the reset button.

💡 Example Values

A few more examples for better understanding.

🔒 Internal Constraints

If the configured value does not meet this requirement, the configuration cannot be saved.

⚠️ External Constraints

If the configured value does not meet this requirement, the theme may not work properly.

🧩 Template Variable

Variables provided for template developers to read this configuration value. Can be used via ${template variable}.

ℹ️ Additional Information

Supplementary information.

Post Metadata

How to find the settings for a post's metadata:

• Method 1: Go to post management page (/console/posts) -> Click the three dots on the right of a post -> Select "Settings" in the context menu that pops up -> Scroll to the bottom to see metadata settings
• Method 2: Go to post management page (/console/posts) -> Click the "Settings" button to the left of the "Publish" button in the upper right corner -> Scroll to the bottom to see metadata settings

Post Page Title

🎯 Purpose

Sets the HTML title of the post on the browse page. If the configured value is empty, the HTML title will take the post title.

📂 Configuration Item Location

Post Metadata -> Page Title

🏷️ Type

String

⭐ Default Value

Empty

💡 Example Values

• Halo Theme Guide

⚠️ External Constraints

If the configured value is too long, it may affect SEO and page display.

🧩 Template Variable

#annotations.get(post, 'higan.howiehz.top/page-title')

Fallback to post title when empty: #annotations.getOrDefault(post, 'higan.howiehz.top/page-title', post.spec?.title)

Post Page Language

🎯 Purpose

Sets the page language (HTML lang attribute) of the post on the browse page. If the configured value is empty, it will fall back according to page language setting priority.

📂 Configuration Item Location

Post Metadata -> Page Language

🏷️ Type

String

⭐ Default Value

Empty

💡 Example Values

zh, zh-CN, zh-Hans, en, en-US

⚠️ External Constraints

The set value must comply with BCP 47, otherwise it is invalid.

🧩 Template Variable

#annotations.get(post, 'higan.howiehz.top/page-language')

Show in Post List

🎯 Purpose

Sets whether the post is displayed in the post list (including Home, Tag Detail Page, Category Detail Page, Author Detail Page, Archive Page).

📂 Configuration Item Location

Post Metadata -> Show in Post List

🏷️ Type

Boolean

⭐ Default Value

true

🧩 Template Variable

#annotations.getOrDefault(post, 'higan.howiehz.top/show-in-post-list', 'true')

Category Metadata

How to find the settings for a category's metadata:

• Go to post category management page (/console/posts/categories) -> Click the three dots on the right of a category -> Select "Edit" in the context menu that pops up -> Scroll to the bottom to see metadata settings

Category Page Title

🎯 Purpose

Sets the HTML title of the category detail page. If the configured value is empty, the HTML title will take the category name.

📂 Configuration Item Location

Category Metadata -> Page Title

🏷️ Type

String

⭐ Default Value

Empty

💡 Example Values

• Halo Theme Guide

⚠️ External Constraints

If the configured value is too long, it may affect SEO and page display.

🧩 Template Variable

#annotations.get(category, 'higan.howiehz.top/page-title)

Fallback to category name when empty: #annotations.getOrDefault(category, 'higan.howiehz.top/page-title', category.spec?.displayName)

Category Page Language

🎯 Purpose

Sets the page language (HTML lang attribute) of the category detail page. If the configured value is empty, it will fall back according to page language setting priority.

📂 Configuration Item Location

Category Metadata -> Page Language

🏷️ Type

String

⭐ Default Value

Empty

💡 Example Values

zh, zh-CN, zh-Hans, en, en-US

⚠️ External Constraints

The set value must comply with BCP 47, otherwise it is invalid.

🧩 Template Variable

#annotations.get(category, 'higan.howiehz.top/page-language')

Tag Metadata

How to find the settings for a tag's metadata:

• Go to post tag management page (/console/posts/tags) -> Click the three dots on the right of a tag -> Select "Edit" in the context menu that pops up -> Scroll to the bottom to see metadata settings

Tag Page Title

🎯 Purpose

Sets the HTML title of the tag detail page. If the configured value is empty, the HTML title will take the tag name.

📂 Configuration Item Location

Tag Metadata -> Page Title

🏷️ Type

String

⭐ Default Value

Empty

💡 Example Values

• Halo Theme Guide

⚠️ External Constraints

If the configured value is too long, it may affect SEO and page display.

🧩 Template Variable

#annotations.get(tag, 'higan.howiehz.top/page-title')

Fallback to site title when empty: #annotations.getOrDefault(tag, 'higan.howiehz.top/page-title', tag.spec?.displayName)

Tag Page Language

🎯 Purpose

Sets the page language (HTML lang attribute) of the tag detail page. If the configured value is empty, it will fall back according to page language setting priority.

📂 Configuration Item Location

Tag Metadata -> Page Language

🏷️ Type

String

⭐ Default Value

Empty

💡 Example Values

zh, zh-CN, zh-Hans, en, en-US

⚠️ External Constraints

The set value must comply with BCP 47, otherwise it is invalid.

🧩 Template Variable

#annotations.get(tag, 'higan.howiehz.top/page-language')

Page Metadata

How to find the settings for a page's metadata:

• Method 1: Go to page management page (/console/single-pages) -> Click the three dots on the right of a page -> Select "Settings" in the context menu that pops up -> Scroll to the bottom to see metadata settings
• Method 2: Go to page management page (/console/single-pages) -> Enter a page's edit page -> Click the "Settings" button to the left of the "Publish" button in the upper right corner -> Scroll to the bottom to see metadata settings

Custom Template

Post Page Style

🎯 Purpose

Make custom pages use a layout and style similar to post pages.

📂 Configuration Item Location

Custom Page Style -> Custom Template

ℹ️ Additional Information

When enabled, custom pages will use a layout and style similar to post pages. Mainly reflected in:

1. Desktop top menu (sidebar table of contents, back to top button, share menu)
2. Mobile bottom menu (collapsible table of contents, back to top button, share menu)
3. And, menu and table of contents related settings remain consistent with corresponding settings under Post Page Style.

Page Title

🎯 Purpose

Sets the HTML title of the page. If the configured value is empty, the HTML title will take the page title.

📂 Configuration Item Location

Page Metadata -> Page Title

🏷️ Type

String

⭐ Default Value

Empty

💡 Example Values

• Halo Theme Guide

⚠️ External Constraints

If the configured value is too long, it may affect SEO and page display.

🧩 Template Variable

#annotations.get(singlePage, 'higan.howiehz.top/page-title')

Fallback to site title when empty: #annotations.getOrDefault(singlePage, 'higan.howiehz.top/page-title', singlePage.spec?.title)

Page Language

🎯 Purpose

Sets the page language (HTML lang attribute). If the configured value is empty, it will fall back according to page language setting priority.

📂 Configuration Item Location

Page Metadata -> Page Language

🏷️ Type

String

⭐ Default Value

Empty

💡 Example Values

zh, zh-CN, zh-Hans, en, en-US

⚠️ External Constraints

The set value must comply with BCP 47, otherwise it is invalid.

🧩 Template Variable

#annotations.get(post, 'higan.howiehz.top/page-language')