文章

使用Chirpy模板撰写文章的技巧

使用中一些需要注意的地方

使用Chirpy模板撰写文章的技巧

文章的头信息(Front Matter)

文章作为.md文件存在/_posts中, 每个.md文件需要有一段头信息(frontmatter), 可参照撰写新帖子, 其中更改作者author可见Author Information. 关于更深入的内容可参照Front MatterPosts.

事实上, 在如下Front Matter中仅有titledate是必选项.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
---
layout: # 在Chirpy模板中默认为post
permalink: # 最终导向的URL
title: TITLE
description: DESCRIPTION # 可选
author: # 默认是social.name
date: YYYY-MM-DD HH:MM:SS +0800 # 时间和时区可选
categories: [TOP_CATEGORIE, SUB_CATEGORIE] 
tags: [TAG]
excerpt_separator: # 摘录段落
published: # 是否公开
toc: true # 目录
comment: true # 评论区
pin: true # 置顶
math: true # 数学模式, 由MathJax支持
mermaid: true # Markdown的一种扩展, 用于画图
cdn: url # 只能作为img的根目录,所以对我作用不大
---

模板独有的类型提示

markdown中引文以> 在行首出现, Chirpy提供了一些提示(但我不一定记得用):

1
2
3
4
5
6
7
8
9
10
11
> 显示 `tip` 类型提示的例子。
{: .prompt-tip }

> 显示 `info` 类型提示的例子。
{: .prompt-info }

> 显示 `warning` 类型提示的例子。
{: .prompt-warning }

> 显示 `danger` 类型提示的例子。
{: .prompt-danger }

显示 tip 类型提示的例子。

显示 info 类型提示的例子。

显示 warning 类型提示的例子。

显示 danger 类型提示的例子。

内嵌

pdf

我用了<iframe>在网站中内嵌pdf文件,一般是如下形式:

1
2
3
4
<iframe 
    src="<a href="https://cdn.jsdelivr.net/gh/user/repo@version/file/" target="_blank">https://cdn.jsdelivr.net/gh/user/repo@version/file/</a>"
    frameborder="0" width="100%" height="600px">
</iframe>

其中用了js Delivr的CDN,其他链接也可以放。

视频

详见Write a New Post. 对于平台视频可使用如下语法:

1
{% include embed/{Platform}.html id='{ID}' %}

其中{Platform}是平台名称(支持Youtube, Twitch和Bilibili), {ID}是视频ID.

对于一般的视频和音频可以直接用:

1
2
{% include embed/video.html src='{URL}' %}
{% include embed/audio.html src='{URL}' %}

图片

使用

1
![My helpful screenshot](/assets/img/postimg/screenshot.jpg)

脚注

需要写

1
正文[^footnote],正文

而在正文最后可以写反向脚注:

1
[^footnote]: 这是一个脚注
本文由作者按照 CC BY 4.0 进行授权