为了保证每篇“蜂博客”的简洁,每篇博文需遵循三段式结构:
当前部分是“蜂博客”的第一部分: Why。
在“Why”部分需要指出:
例如,当前博文的“Why”部分需要指出,当前博客是为了解决以下问题:
当前部分是“蜂博客”的第二部分: What。
在“What”部分需要指出:
例如,当前博文“What”部分需要罗列出“蜂博客”需要遵循的规则:
title
,category
,tags
和description
Why? What? How?
三段式结构Markdown
语法当前部分是“蜂博客”的第三部分: How。
在“How”部分需要指出:
例如,当前博文的“How”部分需要就每一条“蜂博客”的规则列出具体的描述和实现。
“蜂博客”是以.md
格式存储在“蜂工地-GitHub”上。”蜂工地”会读取“蜂博客”文件,并以Markdown
格式渲染在网页中(博客文件名不是博客的title
,下面会解释什么是博客的title
)。
Gatsby
部署会重新编译所有文件(包括博客文件),所以博客的创建时间信息在部署后会丢失。因此,需要在博客文件命中保存创建时间信息。文件名格式如下: [YYYY-MM-DD]---[File-Name].md
,
例如:
2020-02-09—How-to-Write-A-Blog-on-Bee-Playground.md
在每篇博客主题内容的上方,需要用---
指定博客信息,用于”蜂工地”的渲染和检索。博客头格式如下:
---
title: "博客标题(会显示在主页中)"
category: "理论/实践"
tags:
- "标签1"
- "标签2"
description: "博客内容简短描述(会显示在主页中)"
---
title
和description
title
和description
会显示在“蜂工地-Bee Blogs”的博客列表中title
或description
,在主页中会显示空字符category
和tags
这两个博客属性都可以对博客进行筛选显示,但是作用是不一样的。category
只能指定一项,是对博客的分组。而tags
可以指定多项,是给博客添加属性。
对一个事物进行分类是困难的,因为它可能拥有多种属性,博客也是一样。所以category
的颗粒度不能过细,“蜂工地”只分了理论
或者实践
两个组别。其他属性有用标签形式标记。
category
category
指定“蜂博客”的分组:理论
或者实践
tags
tags
指定了“蜂博客”的标签tags
有:GettingStarted
,Intro
等category
中的理论和实践是如何划分的?
理论是对实践的总结,实践是对理论的实现。只有理论没有实践,会对理论理解不深刻。只有实践没有理论,就没办法举一反三。
在计算机领域,技术日新月异,每一项技术实践都有可能在短时间被替代而过时,而技术理论的生命周期却可以相对长久。例如,jQuery
曾经风靡一时,但如今已被各种前端框架(如:React
、Vue
等)所取代。而MVC
架构的理论概念却经久不衰。因此,善于从实践中总结理论是学习计算机知识的不二法门。掌握了技术理论的来龙去脉,自然能轻松应变繁复多变的实践方式。
因此,“蜂博客”希望能总结出更多的理论文章,达到举一反三的效果。
“蜂博客”需按三段式组织博客内容:
之所以规定三段式结构,是为了让“蜂博客”的内容更加简洁。“蜂博客”追求博文的小而美,让读者可以在最短的时间了解博客内容。因此,在写“蜂博客”之前,应先考虑:
“蜂博客”需按照Markdown语法编写,以保证博客渲染格式。详情可参见博文:“蜂博客”文档格式简介