如何写好一篇博客
如何写好一篇博客
front matter
典型的front matter如下所示:
1
2
3
4
5
6
7
8
---
title: TITLE
date: YYYY-MM-DD HH:MM:SS +/-TTTT
categories: [TOP_CATEGORY, SUB_CATEGORY]
tags: [TAG1, TAG2] # TAG names should always be lowercase
description: Short summary of the post. # optional
pin: true # optional
---
- 日期:可以设置精确到秒的时间戳和时区,一般制定到日期即可。
- 分类和标签:均支持中文,不同分类和标签用逗号分隔,分类最大支持2级,标签数量无限制。
- 描述:默认情况下,文章的最前面内容将作为文章的描述信息,也可以在这里手动设置描述信息的内容,非必须。
分类和标签的使用规范
- 分类:用来表示文章的主要主题和大方向,层次结构较强,一个文章只能归于一个主要分类,帮助构建博客的整体框架。
- 标签:用于描述文章涉及的具体内容、细节和关键词,没有严格的层级关系。可以根据文章内容灵活添加,既可以用于描述文章的细节,也能弥补分类无法覆盖的内容角度。每篇文章可以附加多个标签。
考虑自己的兴趣,选择以下几个方向作为主要分类。
- AI: 和人工智能相关的话题和研究,后期可以再进一步细分。
- SDE: 软件开发,编程技术相关内容
- car: 自动驾驶,车辆软件开发与车辆工程相关内容。
- productivity: 提高工作效率、优化时间管理和个人生产力的技巧和工具。
- investment: 和投资相关的总结,把投资当作一场长线的人生游戏。
- life: 读书笔记,日常感想,旅行记录等。
- introspect: 定期的反省和总结
- principles: 值得反复阅读并身体力行的观点
- reading: 阅读笔记
- workout: 健身相关的笔记
文章排版
参考少数派的风格指南。
markdown语法注意点
不要添加1级标题,从2级标题开始分级,这样TOC导航才能正常显示。
提示语
chirpy主题支持以下4种提示语:
this is an info prompt.
this is an warning prompt.
this is an tip prompt.
this is an danger prompt.
多媒体
以文字说明为主,尽可能不要插入图片,如果需要插入图片,优先选择使用外部链接插入,如果是需要插入截图等本地图片,则进行合理化命名之后,将其保存在assets/imgs
文件夹中。
视频插入的格式如下:
1
2
3
4
5
# youtube, bilibili
{% include embed/{Platform}.html id='{ID}' %}
# other platforms
{% include embed/video.html src='{URL}' %}
This post is licensed under CC BY 4.0 by the author.