Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/syhily/yufan.me/llms.txt

Use this file to discover all available pages before exploring further.

yufan.me stores all site configuration in database-backed settings sections — each section saves independently, so changes you make on one settings tab never overwrite values saved from another. Navigate to /admin/settings to access all settings pages described below.

General (blog.general)

Path: /admin/settings/general The General section controls your site’s identity. These values are collected during the two-stage install flow and can be edited at any time afterwards.
FieldDescription
Site nameThe title displayed in the browser tab, OG cards, and the RSS feed
DescriptionShort tagline shown in the site header and as the default meta description
WebsiteCanonical URL of your blog (used in feeds and SEO tags)
KeywordsUp to 20 keywords for site-level meta tags
Author name / email / URLDisplayed in the feed and used for author meta
LocaleBCP 47 language tag (e.g. zh-CN, en-US)
Time zoneIANA time zone name (e.g. Asia/Shanghai, UTC)
Time formatToken string consumed by formatLocalDate
Initial yearCopyright range start year
ICP numberOptional — displayed in the footer for Chinese hosting compliance
MOE ICP numberOptional — supplementary filing number

Assets (blog.assets)

Path: /admin/settings/assets The Assets section configures your CDN base URL, S3-compatible storage credentials, and upload limits. Images and music both resolve their public URLs from the asset.host set here.

CDN and scheme

Set the asset host (hostname only, no scheme) and select http or https. Every public image and music URL is built as <scheme>://<host>/<storagePath>.

S3 object storage

S3 is disabled by default on a fresh install. Enable it after entering valid credentials.
FieldDefaultDescription
Enable S3 uploadsOffMaster toggle — uploads return 503 when off
EndpointS3-compatible endpoint URL (e.g. https://s3.us-east-1.amazonaws.com)
RegionBucket region (e.g. us-east-1)
BucketBucket name
Access key IDS3 access key ID
Secret access keyS3 secret access key (send empty to keep the existing value)
Force path styleOffEnable for MinIO and other path-style S3 providers
URL templateOptional custom URL template for public object URLs
All storage fields (endpoint, region, bucket, access key ID) become required the moment you enable the S3 toggle. The form validates these constraints client-side, but the API enforces them server-side as well. Flipping the toggle off does not erase your credentials — you can re-enable storage without re-entering them.

Upload limits

FieldDefaultDescription
Max upload size8 MiBMaximum bytes per uploaded file (1 KB – 50 MiB)
JPEG quality82Compression quality applied by Sharp on upload (40 – 100)

Content (blog.content)

Path: /admin/settings/content The Content section controls pagination page sizes, feed behaviour, post sorting, the featured-posts widget, and the footnote section heading.

Pagination

Each listing page type has its own per-page count (1 – 100). Defaults are 10 for all four surfaces.
FieldDefault
Posts per page10
Category pages per page10
Tag pages per page10
Search results per page10

Feed

FieldDefaultDescription
Full contentOffInclude full post HTML in the feed; off means excerpt only
Max feed items20Number of posts in the RSS/Atom output (1 – 100)

Post ordering

FieldDefaultOptions
Sort bypublishedAtpublishedAt, updatedAt
Sort orderDescendingAscending, Descending
Toggle Feature enabled to show a featured-posts section on the home page. When disabled, the section is hidden regardless of which posts are marked as featured.

Footnotes

Section title — the heading rendered above the footnotes list at the bottom of a post. Defaults to 尾声礼记. Path: /admin/settings/sidebar The Sidebar section controls which widgets appear in the site sidebar and in what order. Each of the five widget slots has an enabled toggle; count-based widgets also have a configurable item count.
WidgetCount configurableDefault count
SearchNo
Recent PostsYes5
Recent CommentsYes5
Random TagsYes20
Today’s CalendarNo
All widgets are disabled by default on a fresh install.

Fonts (blog.fonts)

Path: /admin/settings/fonts The Fonts section controls the typefaces used in server-rendered outputs (Open Graph images and calendar SVGs) and the CSS font declarations injected into the public site.
FieldDescription
OG image font URLAbsolute URL of the font file loaded by the OG image renderer
Calendar SVG font URLAbsolute URL of the font file loaded by the calendar SVG renderer
Global CSS font declarationsArray of stylesheet URLs injected as <link> tags site-wide (max 8)
Post body CSS font declarationsArray of stylesheet URLs injected only on post pages (max 8)
Leave all fields empty to fall back to system fonts. The site renders correctly on a fresh install without any font configuration — OG images and calendar SVGs will use the server’s default sans-serif until you supply URLs.

Build docs developers (and LLMs) love