kenjiefx/scratch-php

使用PHP构建的静态网站生成器

dev-main 2024-05-02 05:04 UTC

This package is not auto-updated.

Last update: 2024-09-20 22:07:36 UTC


README

使用PHP构建的简单、可扩展的静态网站生成器

安装

此包可在Composer中找到。要在根目录中安装,请执行以下命令

composer require kenjiefx/scratch-php

入门

要开始,在包安装后,按照以下步骤操作

  1. 在您的根目录中创建一个名为 'scratch' 的新文件
  2. 将以下代码复制并粘贴到文件中。
<?php
use Kenjiefx\ScratchPHP\App;

define('ROOT',__DIR__);
require ROOT.'/vendor/autoload.php';

$app = new App();
$app->run();
  1. 在您的根目录中创建 /pages 目录(以下讨论)
  2. 在您的根目录中创建 /dist 目录(以下讨论)
  3. 在您的根目录中创建 /theme 目录(以下讨论)

创建新主题

要创建新主题,只需运行以下命令

php scratch create:theme name_of_your_theme

您可以在根目录的 \theme 文件夹中找到创建的新主题。注意,根目录中还会创建一个名为 scratch.config.json 的文件。

创建索引/主页

要开始新页面,只需在根目录的 \pages 文件夹中创建一个名为 index.json 的文件,内容如下

{
    "template": "index",
    "title": "Hello, Scratch!"
}

构建您的页面

要构建索引/主页,只需运行以下命令

php scratch build

注意,在您的 /dist 文件夹中,您可以看到由 ScratchPHP 渲染的页面和资源。

在本地服务器中查看您的站点

您可以安装任何为服务静态网站而构建的框架,例如ExpressJS。