首页
5. 备受推荐的 Ghost 博客主题结构设计

任何一个项目,如果有一个良好的组织规范和结构设计,那么便成功了一半,这在工程实践上是至关重要的。

对于 Ghost 博客主题来说,一个比较规范的结构设计,会让我们的主题开发变得十分轻松。对此,官方教程里也有 Recommended Structure(推荐结构),如下:

.
├── /assets
    ├── /css
        ├── screen.css
    ├── /fonts
    ├── /images
    ├── /js
├── /partials
    ├── list-post.hbs
├── default.hbs
├── index.hbs [required]
└── post.hbs [required]
└── package.json [required]

在参考了大量优秀的 Ghost 主题源码后,对于 Recommended Structure 我自己有一些心得。 在这篇教程中我们会做一些调整,下面我会仔细解说。

Recommended Structure

直接上图吧,最后我们的主题结构如下:

image_1ehs3j3m91bj1l92a496s18kl16.png-20.9kB

这是一个基本的主题结构,大家可以在这个基础上去构建自己的主题。为了方便大家,我专门建了一个分支:https://github.com/KINGMJ/maple-test/tree/features/tutorials-5

partials

partials 目录是 Ghost 主题里一个十分重要的目录,我们可以在这里面建立很多小的模板文件,把一个页面拆分成很多个小的组件。

按照现在前端组件化的思想,一个页面通常是由各种小的组件拼装起来的。比如 index.hbs 里面可能包含文章列表等内容,我们可以在 partials 里面建一个 list-post.hbs 专门负责输出文章列表,然后在 index.hbs 中使用 {{> list-post}} 输出它。

partials 目录还有一个很重要的功能,就是我们可以建立一些模板文件用来覆盖系统内置的模板文件。 比如:系统提供了 {{navigation}} 助手表达式用来输出导航,{{pagination}} 助手表达式用来输出分页。我们可以在 partials 目录里建立 pagination.hbsnavigation.hbs 文件覆盖系统默认的模板。需要注意的是,这种方式直接通过 {{pagination}}{{navigation}} 来输出,而不是用 {{> pagination}} partial 表达式

src

前面讲到主题里的所有资源都放在 assets 目录里,需要引入资源的时候使用 {{asset}} 助手表达式即可。比如:

 <link rel="stylesheet" href="{{asset 'css/style.css'}}">

在实际的开发过程中,assets 目录里面的内容往往是通过 gulp 等构建工具生成的,src 目录才是我们各种资源存放的地方,发布到生产环境时会删掉该目录。

其实,我们也可以不用 assets 目录和 {{asset}} 助手表达式,但官方强烈推荐大家用,毕竟它有以下好处:

  • 确保资源文件的相对路径始终正确
  • 可以缓存资源文件
  • 为主题开发者提供了稳定性......

Templates

在主题文件夹的根目录里,我们可以看到有index.hbspost.hbs这些文件。前面讲到在 partials 里面我们可以创建自定义的模板文件,但根目录里的这些模板文件都必须遵循严格的命名约定,我们称之为系统模板吧。

每个模板用于呈现博客的特定页面或部分(称为 Context),并且每个模板都可以访问特定的数据。有关模板的更多信息,我们之后会在具体的操作中介绍到,你也可以直接访问官网的 模板页面 了解。

image_1c7egrhf731cgpq25j1gb91ks29.png-17kB