README

这是一个模板，它将 markdown .md 文件转换为静态 HTML 页面，具体取决于您将使用的主题。

索引

工厂
主题
测试
编写您自己的主题

工厂

我们有一个工厂，它可以处理所有流程并调用您需要的主题。

$map

这是一个用于我们 markdown 的映射。

$map = [
    'Prologue' => [
        'Setup' => __DIR__.'/docs/prologue/setup.md',
        'Change Log' => __DIR__.'/docs/prologue/change_log.md',
    ],
];

$view_variables

您可以在工厂中自由传递一个变量。请注意，当您使用不同的主题时，这些变量将被覆盖/添加新变量。

$view_variables = [
    'uri' => 'http://example.com',
    'title' => 'My Documentation',
    // and so on ...
];

最后，调用工厂时，请注意以下代码仍然不完整，我们还需要审查主题的工作方式。

<?php

$map = [...];
$view_variables = [...];

$factory = new PhpPure\Themer\Factory($map, $theme_variables, $view_variables);

主题

我们使用 Laravel 的 Blade 组件来处理视图。

PHP Pure 有一个我们可以用于文档的主题，那就是我们在核心中添加的 basic 模板。

$basic = new PhpPure\Themer\Themes\Basic\Basic;
$basic->setViewsDir(__DIR__.'/views');
$basic->setCacheDir(__DIR__.'/views/.cache');

上述代码，我们实例化了 Basic 类，我们设置了 views 文件夹和 cache 文件夹。

Basic 主题要求我们在工厂中注入主题变量，我们必须注入 extension 和 landing_page。

$theme_variables = [
    'extension' => 'html',
    'landing_page' => $map['Prologue']['Setup'],
];

要完成工厂，请查看以下代码。

...

$factory->theme($basic);
$factory->generate('public/'); // the folder to generate with

测试

我们有一些示例测试，您可以尝试或模仿。

编写您自己的主题

我无法在这里写下所有内容，也许我们可以继续到我们的 wiki。

php-pure / themer

维护者

详情

README

索引

工厂

$map

$view_variables

主题

测试

编写您自己的主题