Jigsaw 开源项目使用教程

Jigsaw 开源项目使用教程

jigsawSimple static sites with Laravel’s Blade.项目地址:https://gitcode.com/gh_mirrors/ji/jigsaw

1. 项目的目录结构及介绍

Jigsaw 项目的目录结构如下：

jigsaw/
├── bin/
├── config/
├── resources/
├── source/
├── tasks/
├── vendor/
├── composer.json
├── composer.lock
└── README.md

目录介绍

• bin/: 包含可执行文件，如 jigsaw 命令行工具。
• config/: 存放项目的配置文件。
• resources/: 包含视图文件和其他资源文件。
• source/: 项目的源文件，包括 Markdown 文件和 Blade 模板。
• tasks/: 包含自定义的构建任务。
• vendor/: Composer 依赖包的存放目录。
• composer.json: Composer 配置文件，定义项目的依赖关系。
• composer.lock: Composer 锁定文件，记录当前安装的依赖包版本。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

Jigsaw 项目的启动文件主要是 bin/jigsaw 文件。这个文件是一个可执行的 PHP 脚本，用于启动 Jigsaw 命令行工具。

#!/usr/bin/env php
<?php

require __DIR__.'/../vendor/autoload.php';

use TightenCo\Jigsaw\Jigsaw;
use TightenCo\Jigsaw\Loaders\ConfigLoader;
use TightenCo\Jigsaw\Loaders\DataLoader;
use TightenCo\Jigsaw\Loaders\CollectionConfigLoader;
use TightenCo\Jigsaw\Handlers\CollectionItemHandler;
use TightenCo\Jigsaw\Handlers\PageHandler;
use TightenCo\Jigsaw\Handlers\UnknownPageHandler;
use TightenCo\Jigsaw\Console\Application;

$app = new Application(
    new ConfigLoader(new DataLoader()),
    new CollectionConfigLoader(),
    new CollectionItemHandler(),
    new PageHandler(),
    new UnknownPageHandler()
);

$app->run();

3. 项目的配置文件介绍

Jigsaw 项目的配置文件主要存放在 config/ 目录下。主要的配置文件是 config.php。

<?php

return [
    'production' => false,
    'baseUrl' => '',
    'title' => 'My Jigsaw Blog',
    'description' => 'This is my Jigsaw blog.',
    'collections' => [
        'posts' => [
            'path' => 'posts',
            'sort' => '-date',
            'extends' => '_layouts.post',
            'section' => 'postContent',
            'isPost' => true,
            'comments' => true,
            'tags' => [],
        ],
    ],
];

配置文件介绍

• production: 是否为生产环境。
• baseUrl: 网站的基本 URL。
• title: 网站的标题。
• description: 网站的描述。
• collections: 定义集合，如文章集合 posts。

以上是 Jigsaw 开源项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助。

jigsawSimple static sites with Laravel’s Blade.项目地址:https://gitcode.com/gh_mirrors/ji/jigsaw