rickwest/jigsaw-basically-basic

Jigsaw静态网站生成器博客模板,由Tighten提供


README

这是一个使用Jigsaw创建博客的起始模板。Jigsaw Basically basic是一个简单的Jigsaw实现,基于mmistakes的Jekyll Basically Basic主题,只需更改一些设置即可开始使用。

在此查看博客模板预览

包含内容

这个完全响应式的起始模板包含一些示例页面,并预先配置了以下内容:

  • 使用highlight.js进行语法高亮
  • 自动生成sitemap.xml的脚本
  • 自动生成RSS源的脚本
  • 自定义的404页面

Jigsaw Basically Basic Screenshot

安装

系统要求

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

入门

Jigsaw现在支持安装第三方起始模板,因此您可以通过以下三个简单快捷的步骤开始使用:

  1. 创建项目目录

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

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

        ./vendor/bin/jigsaw init rickwest/jigsaw-basically-basic

现在您已经安装了所有必需的组件,可以使用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 文档可在 此处 查阅。

部署到 Netlify

如果您想直接部署到 Netlify,请点击👇🏻

Deploy to Netlify

错误和问题

如果您遇到问题、发现错误,或者只是想提出建议,请提交一个 issue。我们也非常欢迎 pull requests!

贡献

  • 将其 Fork(https://github.com/yourname/yourproject/fork
  • 创建您的功能分支(git checkout -b feature/fooBar)
  • 提交您的更改(git commit -am '添加一些 fooBar')
  • 将更改推送到分支(git push origin feature/fooBar)
  • 创建一个新的 Pull Request

版权和许可证

本项目遵循 MIT 许可证。