zjkal/twig-view

A simple Twig template previewer

v1.0.0 2025-05-19 15:33 UTC

Requires

• php: >=7.4
• twig/twig: ^3.0

MIT

• zjkal

README

一个简单的Twig模板预览工具，无需配置.htaccess，支持直接访问模板文件。

功能特点

• 直接访问Twig模板文件
• 支持模板数据文件
• 无需配置.htaccess
• 支持模板缓存
• 调试模式支持

系统要求

• PHP >= 7.4
• Composer
• Web服务器（Apache/Nginx）

安装步骤

方法1：使用Composer创建项目

composer create-project zjkal/twig-view my-project
cd my-project

方法2：手动安装

1. 克隆项目

git clone [项目地址]
cd twig-view

1. 安装依赖

composer install

1. 配置Web服务器

• 将网站根目录指向项目目录
• 确保 templates、data 和 cache 目录有写入权限

目录结构

twig-view/
├── assets/        # 静态资源目录
│   ├── css/      # CSS文件
│   ├── js/       # JavaScript文件
│   └── images/   # 图片文件
├── templates/     # Twig模板文件目录
├── data/         # 模板数据文件目录
├── cache/        # 模板缓存目录
├── config.php    # 配置文件
├── index.php     # 入口文件
└── composer.json # 项目依赖配置

使用方法

1. 创建模板

• 在 templates 目录下创建 .twig 文件
• 例如：templates/about.twig

1. 添加数据（可选）

• 在 data 目录下创建同名的PHP文件
• 例如：data/about.php

<?php
return [
    'title' => '页面标题',
    'content' => '页面内容'
];

1. 访问页面

• 访问 http://your-domain/about 将显示 templates/about.twig
• 如果存在 data/about.php，其中的数据将被传递给模板

1. 引用静态资源

• 在模板中引用静态资源时，直接从assets下的目录开始写
• 例如：

{# CSS文件 #}
<link rel="stylesheet" href="/css/style.css">

{# JavaScript文件 #}
<script src="/js/main.js"></script>

{# 图片文件 #}
<img src="/images/logo.png">

配置说明

在 config.php 中可以修改以下配置：

• templates_dir: 模板目录
• data_dir: 数据文件目录
• debug: 是否开启调试模式
• cache_dir: 缓存目录

注意事项

• 确保PHP版本 >= 7.4
• 确保相关目录有正确的写入权限
• 建议在生产环境中关闭调试模式

许可证

MIT License