博客内容规范
博主原创文章,转载请说明出处,但是不说我也管不了你🏳️
前言
最近发现用互联网存储数据是挺方便的,不论是存在自己本地电脑上还是实体纸质笔记本上,一是不方便,二是容易丢失,我自己电脑隔三差五格式化一下,真的风险高,所以决定转移到网络上。当然有想过自己建个站,租个大厂的云服务器,但是是真**的有点贵,遂放弃。思来想去,想起了Gitee,这玩意儿应该不会跑路吧?(注:目前已经确定Gitee Pages已经跑路,我真的笑了)
本着免费的不能浪费的原则,既然Gitee提供了这么一个免费的服务,不用白不用。之前是用的Github,但是时不时Github就被墙,导致每次更新文档或者加载文档都有可能就卡在那了,是真的难用,所以还是放弃了,之前写了几篇内容也荒废在那了,我也懒得管了。
本文章是我在Gitee Pages上的第一篇文章(注:在2024年5月份,Gitee Pages已经无法使用,本人现已经将所有文章转移至Github Pages),本文章将主要为后续博客内容以及格式规范做一个明确的方向指导,本文会不断更新,直至博客格式最终固定下来(注:时至2024年8月20日17:56:00,我的博客格式还是乱七八糟的[笑])。
正文
一、未来内容规划
预计未来会在博客上记录的东西:
二、文章要求说明
目前之所以需要一个规范来约束整篇文章呈现方式,实际上是为了方便整篇文章的阅读,当然还有方便写文章(因为不用每次再去组织文章结构了)。所以,合理使用该规范,例如过于简单的文章,那就随便写写就行了,没必要整太大阵仗。
2.1 分类规范
对于所有文章必须有两个分类,一个是层级分类,一个是非层级分类。
2.1.1 层级分类
层级分类是有层次结构并可用于快速手动索引查询的分类,可通过分类页直接查询某文章,例如某一篇文章的层次分类为:学科->语文->散文这样的有层次结构的分类。归档分类必须遵循层次分明、意义明确的原则,同时原则上归档分类层次不得超过三级。详细的归档分类见附录:归档分类层次表。
2.1.2 非层级分类
非层级分类是没有层次结构的分类,也可叫做标签分类(因为这里实际上是通过加标签的方式来分类文章的)。所有标签均平级,用于给某篇文章的内容关联上详细的属性标签,例如某一篇文章的标签分类为:SpringBoot启动失败、SpringBoot经验总结、常见错误这些的没有划分层次等级的分类。各标签必须描述尽量精确,不能过于笼统,同时一篇文章应该最多不超过五个标签,其中必须有一个标签为原创
或者转载
,若文章还未完成,必须要有个未完成
的标签,所实际上用于描述文章的标签不能超过四个。注:标签分类存在的意义实际上主要是用于扩展文章的元描述内容。
2.2 结构组成
每篇文章主要由以下几个部分组成:
- 封面与摘要:用于读者快速了解文章大致内容。
- 文章详情页横幅:可用于读者快速了解文章大致内容。
- 原创声明:用于标记文章是否原创。
- 完成度声明:因为我经常鸽,防止自己都不知道文章写完没,故加一个说明。
- 前言:用于解释文章诞生原因或者其他前置内容。
- 正文:文章主题内容。
- 附录:文章附属内容,该部分一般是那些篇幅太长不方便放到正文里的内容,例如源代码段。
- 参考资料:用于标注文章引用内容的源。
2.3 各结构内容规范
2.3.1 封面与摘要
每篇文章必须有摘要内容,但是由于空间有限,所以文章的封面可以使用默认封面,不过对于一些比较重要的文章,还是建议找个简洁易懂的封面。注意,对于封面的选取,为适应夜间模式,应当尽量选择背景镂空透明的图片,每张图片尺寸为:270x150PX。
2.3.2 文章详情页横幅
文章详情页横幅实际上是主要用于美观,而且由于这张图很大,为了节省空间,所以一般都是用默认的就行。
2.3.3 原创声明
每篇文章必须要有原创声明,这是用来激励自己的标签,鼓励自己多多原创,注意:若是非原创文章,需要在前言部分再次声明,并注明源地址或者其他引用指引。在每篇文章开头会使用TAG
来强调说明,格式使用fluid的TAG:
原创使用则健康绿色:
博主原创文章,转载请说明出处,但是不说我也管不了你🏳️
转载则使用淡屎黄色:
转载或微调文章,原作者:[在此键入原作者]
2.3.4 前言
每篇文章必须要有前言部分,这样做的目的主要是为了记录每一篇文章的写作目的或者其他重要的关键信息,方便指引读者阅读文章。
2.3.5 正文
正文部分最多分3个层级标题,防止副标题太多影响阅读体验。
2.3.6 附录
为防止后续修改麻烦,附录中的每一个内容不应当有序号索引,每一个附录内容只需有一个标题索引即可,正文中使用HTML内连接来索引附录。
2.3.7 参考资料
本着方便阅读同时方便使用MD文档书写的原则,这里对于所有类型的文献、资料引用格式都是使用一种格式,如下:
作者、其他主要作者...,题名[文献类型标识]:引用页码,出版地:出版者,获取和访问路径,文献更新日期或者出版年
以上是主体结构,看情况来取舍某些内容,例如引用某篇网络博客,则不需要使用出版地、出版者等信息。对于文献类型标识,这里使用《信息与文献-参考文献著录规则》(GB/T7714—2015)里面的规范,如下:
三、其他
因为写一篇博客也不容易,而且我也希望每篇博客尽量写得好一点,所以对于每一篇博客的内容,还是应当做到不是什么阿猫阿狗的东西都要写进博客里面的,如果实在要写,那就写。
附录
归档分类层次表
一级分类 | 二级分类 | 说明 |
---|---|---|
编程实践 | java | java语言语法基础、高级特性、编程应用等相关文章 |
c语言 | c语言语法基础、编程应用等相关文章 | |
python | python语言语法基础、编程应用等相关文章 | |
后端综合 | 后端综合类文章,涉及的知识例如SSM框架、SpringBoot等 | |
前端综合 | 前端综合类文章,涉及的知识例如前端的各种脚手架、三大基础件等 | |
自动化 | 利用各种编程语言、工具实现工作自动化的教程文章,涉及的知识例如自动打卡签到、资源爬取等 | |
其他 | 懒得分类的文章 | |
计算机理论 | 数据结构 | 无 |
操作系统 | 无 | |
计算机组成原理 | 无 | |
计算机网络 | 无 | |
计算机杂项 | 工具的安装、配置或使用 | 就是一些入门的知识,比如JDK环境变量配置、IDEA使用技巧等 |
项目文档、源码的阅读 | 无 | |
其他 | 无 | |
语文 | 散文 | 无 |
古诗 | 无 | |
小说 | 无 | |
数学 | 高等数学 | 无 |
离散数学 | 无 | |
线性代数 | 无 | |
英语 | 写作 | 无 |
听力 | 无 | |
口语 | 无 | |
音乐 | 唱 | 蔡徐坤 |
杂想 | 人物关系 | 无 |
社会现象 | 无 | |
反思家附体 | 无 | |
其他 | 无 |