Guide for Template - Getting Started

模板教学说明：这是一篇 Twilight 自带的入门示例文章，主要用于演示文章 Front-matter 和目录结构。你可以保留它作为参考，也可以在熟悉后改写成自己的内容，或者直接删除。

Tip: For the things that are not mentioned in this guide, you may find the answers in the Astro Docs.

中文翻译：提示，如果本指南没有提到你遇到的问题，可以在 Astro 文档中继续查找答案。

Front-matter of Posts

中文翻译：这一节展示文章头部 Front-matter 的常用字段格式，创建新文章时可直接参考。

1
---
2
title: My First Blog Post
3
published: 2020-02-02
4
description: This is the first post of my new Astro blog.
5
cover: ./cover.jpg
6
coverInContent: false
7
tags: []
8
category: Guides
9
comment: true
10
draft: false
11
---

Attribute	Description
`title`	The title of the post.
`published`	The date the post was published.
`pinned`	Whether this post is pinned to the top of the post list.
`description`	A short description of the post. Displayed on index page.
`cover`	The cover image path of the post. 1. Start with `http://` or `https://`: For web image 2. Start with `/`: For image in `public` dir 3. With none of the prefixes: Relative to the markdown file
`coverInContent`	Whether to show the cover image in the post content.
`tags`	The tags of the post.
`category`	The category of the post 1. Single category: `category: Guides` 2. Multi-category: `category: [Guides, Getting Started]`
`licenseName`	The license name for the post content.
`author`	The author of the post.
`sourceLink`	The source link or reference for the post content.
`comment`	Whether to enable comment for this post. Default is `true`.
`draft`	If this post is still a draft, which won’t be displayed.

中文翻译：上表说明了常见字段的用途，其中 pinned 控制是否置顶，draft 为 true 时文章不会在正式环境显示。

Where to Place the Post Files

Your post files should be placed in src/content/posts/ directory. You can also create sub-directories to better organize your posts and assets.

中文翻译：文章文件建议放在 src/content/posts/ 目录中，也可以按主题建立子目录来整理文章与配图资源。

1
src/content/posts/
2
├── post-1.md
3
└── post-2/
4
    ├── cover.jpg
5
    └── index.md

Xs's Blog

Front-matter of Posts

Where to Place the Post Files