Cirry's Blog

Astro-Yi主题配置和写作技巧

Mar 24, 2023
技术 astro
12分钟
2268字

介绍

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

配置Astro-Yi

本博客唯一的配置文件位置在src/consts.ts,您可以根据自己的需求进行一些修改。

博客信息配置

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

/src/consts.ts
export const site = {
title: "Cirry's Blog", // 网站标题(必须填写)
favicon: '/favicon.svg', // 网站图标(必须填写)
author: "Cirry", // 文章作者名称(必须填写)
avatar: '/avatar.png', // 头像(必须填写)
description: '', // 网站描述(建议填写)
motto: '', // 个性签名(建议填写)
url: 'https://cirry.cn', // 网站地址(必须填写)
baseUrl: '', // 当您使用github pages部署的时候,必须填入仓库名称以/开头类似: '/astro-blog'
recentBlogSize: 5, // 显示最近文章数量(必须填写)
archivePageSize: 25, // 归档文档每页数量(必须填写)
postPageSize: 10, // 博客每页展示文章数量(必须填写)
feedPageSize: 15, // 动态页面每天展示文章数量(必须填写)
beian: '', // 国内网站备案信息
asideTagsMaxSize: 0 , // 当侧边展示的标签太多的时候,可以设置展示更多
1 collapsed line
}

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

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

填完上面配置,就已经配置完了网站了,想要更多的功能和内容继续往下看。

评论系统配置

评论支持对接waline和giscus,目前来说giscus更简单一点,waline更方便迁移和配置。

安装waline可以参考Waline官网或者我的文章安装waline评论功能

安装giscus可以参考giscus官网基于 giscus 为网站添加评论系统

/**
* @typedef {Object} WalineConfig - Waline 评论系统的配置
* @property {string} serverUrl - Waline 服务端地址
* @property {string} lang - 评论语言
* @property {number} pageSize - 每页显示的评论数量
* @property {string} wordLimit - 评论字数限制
* @property {number} count - 显示的评论数量
* @property {boolean} pageview - 是否启用页面浏览量统计
* @property {boolean} reaction - 是否启用表情反应
* @property {string[]} requiredMeta - 必填的用户信息字段
* @property {string[]} whiteList - 白名单路径,允许评论的页面路径
*/
/**
* @typedef {Object} GiscusConfig - Giscus 评论系统的配置
44 collapsed lines
* @property {string} data-repo - GitHub 仓库名称
* @property {string} data-repo-id - GitHub 仓库 ID
* @property {string} data-category - 评论分类
* @property {string} data-category-id - 评论分类 ID
* @property {string} data-mapping - 评论映射方式
* @property {string} data-strict - 是否严格匹配
* @property {string} data-reactions-enabled - 是否启用表情反应
* @property {string} data-emit-metadata - 是否发送元数据
* @property {string} data-input-position - 评论输入框位置
* @property {string} data-theme - 评论主题
* @property {string} data-lang - 评论语言
* @property {string} crossorigin - 跨域请求设置
*/
export const comment = {
enable: false,
type: 'giscus', // waline | giscus,
walineConfig:{
serverUrl: "https://xxxxx.xxxxx.app",
lang: 'en',
pageSize: 20,
wordLimit: '',
count: 5,
pageview: true,
reaction: true,
requiredMeta: ["nick", "mail"],
whiteList: ['/message/', '/friends/'],
},
// giscus config
giscusConfig: {
'data-repo': "xxxxxxx",
'data-repo-id': "xxxxxx",
'data-category': "Announcements",
'data-category-id': "xxxxxxxxx",
'data-mapping': "pathname",
'data-strict': "0",
'data-reactions-enabled': "1",
'data-emit-metadata': "0",
'data-input-position': "bottom",
'data-theme': "light",
'data-lang': "xxxxxxxxxxx",
'crossorigin': "anonymous",
}
}

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

友情链接配置

/**
* 友情链接
* name: 博客名称
* url: 博客地址
* avatar: 博客头像
* descript: 博客描述
* @type {[{name: string, description: string, avatar: string, url: string}]}
*/
export const friendlyLinks = [
{
name: "Cirry's Blog",
url: 'https://cirry.cn',
avatar: "https://cirry.cn/avatar.png",
description: '前端开发的日常'
},
1 collapsed line
]

赞助系统配置

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

搭建网站教程

本网站是在Debian11下,使用docker搭建waline做评论系统、gitea文档仓库、drone做自动部署,在服务器中安装postgres作为waline和docker的数据库,并定期备份到华为的obs中。

搭建流程和文章都有记录,在网站中使用搜索功能,搜索对应的关键词就能看到文章,欢迎大家一起搭建使用。

写作技巧

Markdown文档规范

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

编写博客页面

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

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

  1. 比如我们想要给文档添加标签和分类或者置顶某些文档,我们可以在Frontmatter中给文档添加一些属性,比如tags, sticky等等。

  2. 比如为避免使用中文作为博客路径和文件名称,我们可以给md文档单独设置title为中文标题,文件名使用英文并用-作为单词连接符号。

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

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

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

---
title: 菩萨蛮·花明月暗笼轻雾 // 文件名称
description: 此词当是李煜描写自己与小周后幽会之情景,创作于北宋乾德二年(公元964年)前后。 // 文档描述
date: 2023-01-25 // 发布日期
tags: // 文档标签支持数组和字符串
- 诗词
category: 诗词 // 文档分类支持数组和字符串
sticky: 100 // 文档置顶权重,数字越大,权重越大
slug: poem/ci // 文档永久链接
mathjax: false // 是否开启公式显示
draft: false // 是否为草稿
toc: true // 是否需要文章标题目录
donate: false // 是否需要开启赞助功能
comment: false // 是否需要开启评论功能
ogImage: // 添加文章封面在分享链接时候显示
1 collapsed line
---

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

编写动态页面

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

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

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

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

---
date: 2023-01-25 10:23:31
---

Vscode自动生成frontmatter

参考信息:Snippets in Visual Studio Code

左下角->设置功能->选择添加用户代码片段

default

然后选择新建全局代码片段

default

输入代码片段文件名称后回车,会自动创建文件

{
"Print to console": {
"scope": "md,mdx,markdown",
"prefix": "mf",
"body": [
"---",
"title: ${0:$TM_FILENAME_BASE}",
"date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
"description:"
"---"
],
"description": "Log output to console"
}
}

配置完成之后,在markdown文件中,输入mf按下tab就可以生产frontmatter信息了。

加载本地图片

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

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

使用图床配合PicGo

我是使用的华为免费的对象存储服务,配合picgo的华为云obs插件图片上传。可以参考华为云对象存储-PicGo插件

修改图标

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

取消锚点跳转

文章浏览点击锚点跳转之后,使用浏览器自带的返回按钮,会跳转到上一个锚点的位置,而不是上一个页面。 在src/components/Toc.astro中的第48行添加如下代码可以实现,取消锚点显示跳转到上一个页面。

src/components/Toc.astro
tocbot.init({
tocSelector: ".toc-container",
contentSelector: ".markdown-body",
headingSelector: "h1,h2,h3",
hasInnerContainers: true,
headingsOffset: 80,
scrollSmoothOffset: -80,
scrollSmoothDuration: 200,
collapseDepth: 3,
onClick: function (){
return false
},
});
本文标题:Astro-Yi主题配置和写作技巧
文章作者:Cirry
发布时间:Mar 24, 2023
感谢大佬送来的咖啡☕
alipayQRCode
wechatQRCode
总访问量
总访客数人次