记录个人博客文档的相关说明,为之后写博客、统一风格提供参考,参考文档说明。
头信息
markdown文档的头部需要包含YAML头信息才能被正确解析,头信息必须在文件的开始部分,并且需要按照YAML格式写在两行三虚线之间。
---
layout: post
title: Blog
author: Su
---
常用的配置变量见下:
变量名称 | 描述 |
---|---|
layout |
指定模板文件,不需要扩展名,必须在 _layout 目录下 |
permalink |
博客默认的URL地址为 /year/month/day/title.html ,设置此变量可以指定URL地址 |
published |
设置为false,站点生成后不会显示该博文 |
date |
覆盖文章名字中的日期,格式为 YYYY-MM-DD HH:MM:SS +/-TTTT ,其中时分秒和时区可选 |
category categories |
为博客指定一个或多个分类,当指定多个分类时需要通过YAML List格式或以逗号隔开的字符串: categories: - part1 - part2 |
tags |
类似分类 categories ,可以为文章添加一个或多个标签,通过YAML列表或者逗号隔开的字符串 |
excerpt_separator excerpt |
在文章YAML头信息中增加 excerpt 或者 excerpt_separator 覆盖自动生成的摘要,格式见下:— excerpt_separator:info — Excerpt info Out-of-excerpt |
撰写博客
文件名格式:
YYYY-MM-DD-标题.markup
代码高亮语法:
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><table class="rouge-table"><tbody><tr><td class="gutter gl"><pre class="lineno">1
</pre></td><td class="code"><pre><span class="n">codes</span>
</pre></td></tr></tbody></table></code></pre></figure>
tips
- 文章标题设置
2024.10.5更新博客时发现yaml头文件语法错误,提示:
Error in user YAML: (<unknown>): mapping values are not allowed in this context at line 1 column 20
搜索之后发现标题或其他字段中有特殊字符(如冒号、引号),需要用引号包裹整个字符串。
- 图片url
2024.10.6上传论文笔记时发现图片无法正常显示,尝试更换路径以及文件类型后发现不能使用相对路径(相对路径在vscode中预览时显示正确,但是当网页解析加载图片资源时会出现错误),因此只能使用绝对路径(但是在vscode中预览时无法加载图片)
图片等静态资源放置 assets\images
文件夹下,插入图片语法:

- vscode无法加载html页面视图
2024/10/20使用vscode打开md或pdf文件时,显示”vscode加载web 视图,报错:Error: Could not register serviceworkers: InvalidstateError: Failed to regist“,解决方案:关闭vscode,打开cmd命令行窗口,输入下面代码重启即可。
code--no-sandbox
git push
失败OpenSSL SSL_read: SSL_ERROR_SYSCALL, errno 0
:vim ~/.gitconfig
,将其中的sslverify
修改为false
Failed to connect to github.com port 443 after 21090 ms: Could not connect to server
:网络问题,换个网络再上传
- 博客公式显示问题
- 行间公式:在
base.html
的</head>
前添加解析script
解析信息 - 行内公式:解决起来比较复杂,需要在yaml头信息之后添加解析信息,行内输入公式时格式为`(latex公式)`,注意latex公式要使用美元符号$包围。参考:配置、让Github Page支持Latex。
- 行间公式:在