Creating Content

Directory Structure

src/content/
├── blog/
├── note/
├── project/
└── page/

blog is for blog posts, note is for notes, project is for projects, and page is for fixed pages (e.g. about, links).

Content Organization

Directories under blog/, note/, and project/ organize source files only. They do not create category pages or category navigation. Use tags as the only content classification and navigation system.

The optional type field may be kept as article display metadata in frontmatter, but it does not create a category route.

Articles

Files in md or mdx format are supported.

Recommended frontmatter for blog and note:

---
routeSlug: 'deploy-astro-star'
title: 'Astro-star Deployment Log'
description: 'A record of the process from build to server launch.'
createdAt: '2026-05-03 20:30'
updatedAt: '2026-05-03 20:30'
type: 'Building'
tags:
  - Astro
  - Building
---

Variables	Description
routeSlug	Defines the end of the article URL
title	Article title
description	Article description
createdAt	Creation date. Auto-generated from git if absent; generally not needed
updatedAt	Update date. Same as createdAt; generally not needed
type	Optional article category/display metadata; retained in frontmatter without navigation
tags	Optional list of article tags; the only content classification and navigation system

tags must be a YAML list. Values are trimmed and deduplicated case-insensitively; each tag gets a stable URL such as /blog/tag/astro/.

Project Page Frontmatter

---
routeSlug: 'my-project'
title: 'My Project'
description: 'A short project description.'
createdAt: '2026-06-15 23:05:26'
projectUrl: 'https://github.com/your-name/my-project'
docUrl: 'https://example.com/docs'
published: true
tags:
  - Astro
  - Template
---

Field	Description
projectUrl	Project URL (only shown on project page)
docUrl	Project docs URL (only shown on project page)
published	Set to false to hide as draft
tags	Optional list of project tags

Fixed Page Frontmatter

For pages under src/content/page/ (e.g. about, links):

---
title: About Me
heading: About
description: This page introduces me and this site.
background: code-rain
---

background options: code-rain, snow, constellation.

Common Fields Reference

Field	Description
routeSlug	URL slug, recommended lowercase English with hyphens
title	Page title
description	Summary, used in list pages and SEO
createdAt	Creation time, falls back to Git record or file system time
updatedAt	Update time, same fallback as createdAt
type	Optional article category/display metadata
projectUrl	Project URL (only shown on project page)
docUrl	Project docs URL (only shown on project page)
image	Social share image / SEO image
published	Set to false to hide as draft
tags	Optional list of tags used in article and tag navigation

All frontmatter fields are optional. When omitted, the system falls back to file path, filename, content, or Git timestamps.

Special Syntax Rendering

Fold

Use :::fold syntax to create collapsible content blocks, supporting default collapsed or expanded state:

:::fold[Click to expand]
Hidden content can include paragraphs, lists, and code blocks.
:::

:::fold[Open by default]{open=true}
This fold starts open.
:::

Blur Text

Use ||text|| syntax to create a blur effect -- readers need to hover over the text to reveal the hidden content.

Strikethrough

Use ~~text~~ syntax to render strikethrough text in a muted style.

GitHub Repo Card

A GitHub repository link on its own line in article content is automatically rendered as a card with icons.

Video

Use the block-level :video[title](url) directive to embed a direct video URL, YouTube video, or Bilibili video:

:video[](/videos/demo.mp4)

:video[Demo video](/videos/demo.mp4){poster="/figures/demo.webp"}

:video[YouTube demo](https://youtu.be/VIDEO_ID)

:video[Bilibili demo](https://www.bilibili.com/video/BV1xx411c7mD?p=3)

The title is optional and becomes the figure caption. poster is only supported for direct video URLs. The directive must occupy its own line; playback is loaded after the reader activates it, so articles without video interaction do not request media or embedded players.

Static Resources

Local assets are placed under public/ and referenced from the root path:

• Avatar: place at public/avatar.svg, reference as /avatar.svg in config
• Article images: place under public/figures/, reference as /figures/xxx.png
• Site icon: place at public/site-icon.svg, reference as /site-icon.svg in config
• Reward QR codes: place under public/reward/, reference as /reward/wechat.png in config