rickwest / jigsaw-clean-blog
由 Tighten 提供的 Jigsaw 静态站点生成器的博客起始模板
Requires
- samdark/sitemap: ^2.2
- suin/php-rss-writer: ^1.6
- tightenco/jigsaw: ^1.2
README
这是一个使用 Jigsaw 创建博客的起始模板。Jigsaw Clean Blog,正如其名所示,是一个简单的 Jigsaw 实现,基于 Startbootstrap Clean Blog 主题,只需更改一些设置,就可以开始使用了。
在此处预览博客模板 (链接)。
包含内容
这个完全响应式(基于 Bootstrap 4)的起始模板包含一些示例页面,并预先配置了以下内容:
- 使用 highlight.js 进行语法高亮显示
- 自动生成
sitemap.xml
的脚本 - 自动生成 RSS 源的脚本
- 自定义 404 页面
- 带有 formSpree 集成的联系表单
安装
系统要求
要使用 Jigsaw,您需要在您的机器上安装 PHP 7 和 Composer。您还需要安装 Node.js、NPM 和 Yarn,以便使用 Laravel Mix 编译 CSS 和 JavaScript。
入门指南
Jigsaw 现在支持安装第三方起始模板,因此您可以通过以下 3 个快速简单的步骤开始使用:
-
创建项目目录
mkdir my-cool-blog
-
通过 Composer 安装 Jigsaw
cd my-cool-blog composer require tightenco/jigsaw
-
初始化您的项目
./vendor/bin/jigsaw init rickwest/jigsaw-clean-blog
现在您已经安装了一切,您可以使用 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
添加和编辑页面
通过编辑此项目附带的自定义“关于”页面开始。打开位于 _source
文件夹中的 about.blade.php
,并添加一些关于您的有趣信息!
向您的网站添加新页面就像在 _source
目录中创建新的 blade 模板一样简单。
Jigsaw使您能够访问Laravel中可用的所有Blade模板功能和控制结构。
完整的官方Blade文档可以在这里找到。
部署到Netlify
如果您只想快速开始并将项目直接部署到Netlify 👇🏻
错误和问题
如果您遇到问题、发现错误,或者只是想提出建议,请提交一个问题。我们也非常欢迎pull请求!
贡献
- Fork项目(https://github.com/yourname/yourproject/fork)
- 创建您的功能分支(git checkout -b feature/fooBar)
- 提交您的更改(git commit -am '添加一些fooBar')
- 将更改推送到分支(git push origin feature/fooBar)
- 创建一个新的Pull Request
版权和许可
本项目遵循MIT许可。