Cirry's Blog

介绍

这是我开发的Astro开源博客主题，名字叫Astro-Yi，喜欢的可以点个star啦，感谢关注，欢迎PR！

配置Astro-Yi

必不可少的配置（必须）

Astro项目的配置文件在/astro.config.mjs，其中有一些配置是必不可少的：

1
export default defineConfig({
2
    site: "https://cirry.cn", // 请在这里修改为自己的网站地址
3
})

博客信息配置

在Astro-Yi主题的配置文件src/consts.ts，其中有一些配置是很重要的：

1
// ...
2
export const site = {
3
  title: "Cirry's Blog",  // required
4
  favicon: '/favicon.svg', // required
5
  author: "Cirry", // required
6
  avatar: '/avatar.png', // required
7
  description: '',
8
  motto: '',
9
  url: 'https://cirry.cn', // required
10
  recentBlogSize: 5, // required
11
  archivePageSize: 25, // required
12
  postPageSize: 10, // required
13
  indexPageSize: 10, // required
14
  beian: '',
15
}
1 collapsed line
16
// ...

favicon是网站图标存放位置。文件位置在/public/favicon.svg，请替换为自己的网站图标。

avatar是网站头像存放位置。文件位置在：/public/avatar.png，请替换为自己的网站头像。

评论系统配置

1
/**
2
 * Comment Feature
3
 * enable {boolean}
4
 * type {string} giscus and waline are currently supported.
5
 * walineConfig.serverUrl {string} server link
6
 * walineConfig.pageSize {number} number of comments per page. default 10
7
 * walineConfig.wordLimit {number} Comment word s limit. When a single number is filled in, it 's the maximum number of comment words. No limit when set to 0
8
 * walineConfig.count {number} recent comment numbers
9
 * walineConfig.pageview {boolean} display the number of page views and comments of the article
10
 * walineConfig.reaction {string | string[]} Add emoji interaction function to the article
11
 * walineConfig.requiredMeta {string[]}  Set required fields, default anonymous
12
 */
13
export const comment = {
14
  enable: false,
15
  type: 'giscus', // waline | giscus,
28 collapsed lines
16
  walineConfig:{
17
    serverUrl: "https://xxxxx.xxxxx.app",
18
    lang: 'en',
19
    pageSize: 20,
20
    wordLimit: '',
21
    count: 5,
22
    pageview: true,
23
    reaction: true,
24
    requiredMeta: ["nick", "mail"],
25
    whiteList: ['/message/', '/friends/'],
26
  },
27

28
  // giscus config
29
  giscusConfig: {
30
    'data-repo': "xxxxxxx",
31
    'data-repo-id': "xxxxxx",
32
    'data-category': "Announcements",
33
    'data-category-id': "xxxxxxxxx",
34
    'data-mapping': "pathname",
35
    'data-strict': "0",
36
    'data-reactions-enabled': "1",
37
    'data-emit-metadata': "0",
38
    'data-input-position': "bottom",
39
    'data-theme': "light",
40
    'data-lang': "xxxxxxxxxxx",
41
    'crossorigin': "anonymous",
42
  }
43
}

reaction并不是只能设置true/false，你也可以传入一个数组里面是图片的地址来实现自定义表情，具体详情可以参考这里文章反应。

赞助系统配置

1
/**
2
 * 赞助系统
3
 * enable: true 开启, false 关闭
4
 * tip: 赞助提示
5
 * wechatQRCode: 微信二维码地址，图片地址应放在public目录下
6
 * alipayQRCode: 支付宝二维码地址，图片地址应放在public目录下
7
 * paypalUrl: Paypal二维码地址
8
 * @type {{paypalUrl: string, alipayQRCode: string, enable: boolean, wechatQRCode: string, tip: string}}
9
 */
10
export const donate = {
11
  enable: true,
12
  tip: "感谢大佬送来的咖啡☕",
13
  wechatQRCode: "/WeChatQR.png",
14
  alipayQRCode: "/AliPayQR.png",
15
  paypalUrl: "https://paypal.me/cirry0?country.x=C2&locale.x=zh_XC",
1 collapsed line
16
}

友情链接配置

1
/**
2
 * 友情链接
3
 * name: 博客名称
4
 * url: 博客地址
5
 * avatar: 博客头像
6
 * descript: 博客描述
7
 * @type {[{name: string, description: string, avatar: string, url: string}]}
8
 */
9
export const friendlyLinks = [
10
    {
11
      name: "Cirry's Blog",
12
      url: 'https://cirry.cn',
13
      avatar: "https://cirry.cn/avatar.png",
14
      description: '前端开发的日常'
15
    },
1 collapsed line
16
]

建议的配置

Astro-yi中有很多配置可以丰富我们的页面功能，我有以下建议：

建议启用Waline评论系统。如果不会安装Waline系统，可以参考Waline官网或者安装waline评论功能。
备案号，如果您是中国大陆的使用者，建议添加。
个人链接，让更多的人认识您和您的网站。

写作技巧

Markdown文档规范

如果使用Astro作为博客的话，必不可少的需要使用到Markdown，基础的规范可以参考Github的写作规范基本撰写和格式语法。

在Vscode中自动生成frontmatter

写每一篇文章中，如果需要手动去复制信息并填写日期的话，也是一件很复杂的事情，所以我提供了一个在使用Vscode编写博客时自动生成frontmatter的方法，具体内容可以参考这里Vscode添加Markdown-Frontmatter代码片段。

编写博客页面

在Yi的主题下，你只需要在src/content/blog中新建一个md文档，就可以开始编写你的博客了。

根据Astro的Markdown文档标准，每个文档都应该有自己的frontmatter信息，并在md中文档的头部添加---作为开头和结尾来标记frontmatter，这给我们带来了很多的便利:

比如我们想要给文档添加标签和分类或者置顶某些文档，我们可以在Frontmatter中给文档添加一些属性，比如tags, sticky等等。
比如为避免使用中文作为博客路径和文件名称，我们可以给md文档单独设置title为中文标题，文件名使用英文并用-作为单词连接符号。

在Astro-Yi中，您只需要最简单的设置文档标题title和创作日期date标签，下面就是一个Md文档最简单的frontmatter的设置：

1
---
2
title: 菩萨蛮·花明月暗笼轻雾
3
date: 2024-03-05
4
---

如果您觉得这样的文档属性不太够用，Yi也提供了更多的属性供您使用，这是一个完整的属性配置示例：

1
---
2
title: 菩萨蛮·花明月暗笼轻雾 // 文件名称
3
description: 此词当是李煜描写自己与小周后幽会之情景，创作于北宋乾德二年（公元964年）前后。 // 文档描述
4
date: "2023-01-25T10:23:31.210Z" // 发布日期
5
tags:   // 文档标签支持数组和字符串
6
  - 诗词
7
category: 诗词  // 文档分类支持数组和字符串
8
sticky: 100  // 文档置顶权重，数字越大，权重越大
9
slug: poem/ci // 文档永久链接
10
mathjax: false // 是否开启公式显示
11
draft: false    // 是否为草稿
12
toc: true   // 是否需要文章标题目录
13
donate: false   // 是否需要开启赞助功能
14
comment: false  // 是否需要开启评论功能
15
---

以上的属性除了title和date，其余都是可选的或者是有默认值的，您可以在src/content/config.js中修改他们是否可选或者默认值。

编写动态页面

在Yi的主题下，你只需要在src/content/feed中新建一个md文档，就可以开始编写你的动态了。

动态页面应该是类似朋友圈、微博、推特这样，作为一个临时想说或者想吐槽一些什么的地方。

所以没有给它添加过多的frontmatter限制，您甚至不需要设置title（当然这样的内容也不需要title），但是我们知道发布一个消息，最重要的属性就是发布时间，所以需要设置date。

所以动态页面的Md文档的frontmatter的基础设置应该是这样：

1
---
2
date: 2023-01-25 10:23:31
3
---

加载本地图片

将你的图片文件放在/public/images目录下,如果没有images文件夹就创建一下，然后在Markdown中使用绝对路径/images/xx.png引用即可。

比如您有一张图片名为xxx.png，将其移动到/public/images/2024/文件夹下，那您只需要在md文件中，这样引入![](/images/2024/xxx.png)就可以正常使用了。

修改图标

博客中的所有的图标都是使用开源图标库remixicon，可以自行替换自己喜欢的图标。