Aoyuki Config Reference
478 words | 2 minutes read

The config is a YAML file located at ./aoyuki.config.ts and is used to configure the behaviour of Aoyuki. See the Front Matter Reference for how to configure a blog post.


Aoyuki Config Reference

Title <string>

The title is a string that represents the title of the site. It is required.

SubTitle <string>

The subtitle is a string that represents the subtitle of the site. It is required.

Brand Title <string>

The brand title is a string that represents the brand title of the site. It is required.

Description <string>

The description is a string that represents the description of the site. It is required.

Site <string>

The site is a string that represents the site of the site. It is required.

Locale <string>

The locale is a string that represents the locale of the site. It is required.

The navlinks are an array of objects that represents the navigation links of the site. It is required.

Username <string>

The username is a string that represents the username of the site’s author, see it in the side bar. It is required.

Sign <string>

The sign is a string that represents the sign/bio of the site’s author, see it in the side bar. It is required.

Avatar URL <string>

The avatar URL is a string that represents the avatar URL of the site’s author, see it in the side bar. It is required.

The social links are an array of objects that represents the social links of the site’s author, see it in the side bar. It is required.

Max Sidebar Category Chip <number>

The max sidebar category chip is a number that represents the max sidebar category chip of the site. It is required.

Max Sidebar Tag Chip <number>

The max sidebar tag chip is a number that represents the max sidebar tag chip of the site. It is required.

The max footer category chip is a number that represents the max footer category chip of the site. It is required.

The max footer tag chip is a number that represents the max footer tag chip of the site. It is required.

Tab Title Format <string>

The tab title format is a string that represents the tab title format of the site. It is required.

Tab Title Format Fallback <string>

The tab title format fallback is a string that represents the tab title format fallback of the site. It is required.

Banners <array<object>>

The banners are an array of objects that represents the banners of the site. It is required.

Slug Mode <string: ‘RAW’ | ‘HASH’>

The slug mode is a string that represents the slug mode of the site. It is required.

License <object>

The license is an object that represents the license of the site. It is required.

The banner style is a string that represents the banner style of the site. It is required.

Aoyuki Config Reference - Aoyuki

https://github.com/wlft/aoyuki
Author

wlft

Publish Date

14 January 2026

Avatar
Aoyuki

Update in aoyuki.config.ts

Categories