rickwest / jigsaw-casper

由 Tighten 开发的 Jigsaw 静态站点生成器的博客启动模板,基于 Ghost Casper 主题


README

这是一个使用 Jigsaw 创建博客的启动模板。Jigsaw Casper 是默认的 Ghost 主题 - Casper 的移植版本,只需更改一些设置,你就可以开始使用了。

在这里查看博客模板的预览 这里

包含内容

这个完全响应式的启动模板包含一些示例页面,并预先配置了

  • 语法高亮
  • 支持标签
  • 社交分享
  • 一个自动生成 sitemap.xml 的脚本
  • 一个自动生成 RSS 源的脚本
  • 一个自定义的 404 页面
  • Tinyletter 订阅表单

Jigsaw Casper Screenshot

安装

系统要求

要使用 Jigsaw,您需要在您的计算机上安装 PHP 7 和 Composer。您还需要安装 Node.js、NPM 和 Yarn,以便使用 Laravel Mix 编译 CSS 和 JavaScript。

入门

Jigsaw 现在支持安装第三方启动模板,因此您可以通过以下 3 个简单步骤快速开始

  1. 创建项目目录

    mkdir my-cool-blog
  2. 通过 Composer 安装 Jigsaw

     cd my-cool-blog
     composer require tightenco/jigsaw
  3. 初始化项目

        ./vendor/bin/jigsaw init rickwest/jigsaw-casper

现在您已经安装了一切,您可以使用 PHP ./vendor/bin/jigsaw serve 或使用 Browsersync yarn run watch 来提供站点服务

要了解更多信息,请查看 入门 的官方文档。它真的很棒!

配置您的站点

config.php 中的数组中添加的任何内容都将作为 $page 对象的属性在所有模板中提供。

此项目在几个模板中使用了一些这些站点变量,例如,siteName 在页眉和页脚中都被使用。

通过在 config.php 中添加您的站点名称、电子邮件地址和社交媒体配置文件来快速自定义您的站点。请参阅 Jigsaw 文档 了解更多信息。

添加内容

您可以使用多种文件类型 写入内容。默认情况下,此启动模板期望内容位于 source/_posts/ 文件夹。

每个内容页面的顶部都包含一个 YAML 头部,指定了如何渲染它。使用 title 属性动态生成每个页面的 HTML title 和 OpenGraph 标签。使用 extends 属性定义此内容文件将使用哪个父 Blade 布局进行渲染(例如,_layouts.post 将与 source/_layouts/post.blade.php 一起渲染),使用 section 属性定义期望将此内容放置其中的 Blade "section"。

extends: _layouts.post
section: content
title: Getting Started
date: 2019-01-21
description: Getting started with the Jigsaw blog starter template
image: /assets/images/post-bg.jpg

添加和编辑页面

通过编辑随此项目提供的 'about' 页面开始。打开位于 _source 文件夹中的 about.blade.php 并添加一些关于您自己的有趣信息!

将新页面添加到您的站点就像在 _source 目录中创建一个新的 blade 模板一样简单。

Jigsaw 让您能够访问 Laravel 中可用的所有 Blade 模板功能和控制结构。

全面、官方的blade文档可以在这里找到。

错误和问题

如果您遇到问题或发现错误,或者只是想提出建议,请创建一个问题。我们也非常欢迎拉取请求!

贡献

  • 进行分支复制(https://github.com/yourname/yourproject/fork
  • 创建您的功能分支(git checkout -b feature/fooBar)
  • 提交您的更改(git commit -am '添加一些fooBar')
  • 推送到分支(git push origin feature/fooBar)
  • 创建新的拉取请求

版权和许可

本项目遵循MIT许可协议。