- NO.
- 003
- DATE
- Updated 2026-05-29
- READ
- ~1 min
- STATUS
- Reviewed
Markdown Style Guide
A template article for checking prose typography, links, lists, tables, code, quotes, and image zoom behavior.
This article exists to check Markdown styling. It is not meant to tell a complete story; it covers common prose elements.
Headings and Paragraphs
Body copy should keep a comfortable measure, stable line height, and clear hierarchy. Links such as Astro should have a visible clickable state.
Third-Level Heading
Third-level headings split shorter sections and should not overpower second-level headings.
Lists
- First unordered item
- Second unordered item
- Nested item
- Another nested item
- First ordered item
- Second ordered item
- Third ordered item
Quote
A good template should become stable before it becomes ornamental.
Table
| Capability | Status | Notes |
|---|---|---|
| Bilingual routing | Ready | /zh/ and /en/ |
| Search | Ready | Pagefind builds the index |
| Theme switching | Added | Light / System / Dark |
Code
Inline code such as contentId should be clear without feeling loud.
export function localizedPath(locale: string, path = "") {
const clean = path.replace(/^\/+|\/+$/g, "");
return clean ? `/${locale}/${clean}/` : `/${locale}/`;
}
Image
Clicking the image should open the zoom layer. Press Esc or click the backdrop to close it.
Comments
Comments are powered by GitHub Discussions. Sign in with GitHub to comment. Open the matching Discussion