bologer/pages

构建优质文档的小型实用工具

维护者

详细信息

github.com/bologer/Pages

源代码

问题

安装次数: 11

依赖关系: 0

建议者: 0

安全性: 0

星标: 1

关注者: 2

分支: 0

开放问题: 0

0.1 2020-09-21 17:06 UTC

Requires

MIT f3f511ca87f04536a1e5d7713dede3c66a8f023c

  • Alexander Teshbaev <sasha.tesh.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-22 04:20:27 UTC

README

Build Status Total Downloads

Pages 是一个轻量级的 PHP 工具，用于构建文档。

您可以在项目中使用 CLI 工具或直接引用库文件。

在控制台运行

php vendor/bin/parser.php \
    --docs-dir=/path/to/docs \
    --dist-dir=/path/to/dist \
    --code-highlight-languages=php,javascript \
    --plugins=code

或直接将其放入您的项目中

use Bologer\Pages;
use Bologer\Config;

$config = new Config();
$config->docsFolder = __DIR__ . '/docs';
$config->distFolder = __DIR__ . '/dist';
$config->codeHighlightLanguages = ['html', 'php', 'javascript'];
$config->plugins = ['code'];
$pages = new Pages($config);
$pages->build();

安装 Pages

推荐通过 Composer 安装 Pages。

composer require bologer/pages

文档

您可以在以下位置找到文档 - https://bologer.github.io/pages/docs/get-started.html。

顺便说一句，该链接上的文档是由 Pages 构建的。

示例