README

用于创建文档或静态站点生成器（如 MkDocs）的配置文件的工具，并帮助从您的PHP Web应用程序中生成文档。

当前版本处于alpha阶段，仅支持MkDocs（假设您已经安装了它）。

要求

• PHP版本 >= 5.5.9
• 在运行此工具的同一系统上安装适当的文档生成器程序，例如 MkDocs。

安装

使用Composer进行安装

composer require mogita/docbuilder

使用方法

在构建文档之前，您需要准备所有Markdown文件。DocBuilder将支持从您提供的数据源生成Markdown文件。

按照以下两种方式之一进行配置和构建文档：

通过传递配置定义

use Mogita\DocBuilder\MkDocs;

$options = [
    'site_name' => 'A New Docs Site',
    'pages' => [
        ['Home' => 'index.md'],
        ['About' => 'about.md'],
        ['API Docs' => [
            ['User' => 'user.md'],
            ['Data' => 'data.md']
        ]]
    ],
    'extra' => [
        'i18n' => [
            'prev' => '前一页',
            'next' => '后一页'
        ]
    ],
    'theme' => 'material'
];

$mkdocs = new MkDocs(getcwd() . '/docs', $options);

$res = $mkdocs->build();

if ($res === true) {
    echo 'Success!';
}
else {
    var_dump($res);
}

通过使用逐步设置方法

use Mogita\DocBuilder\MkDocs;

$mkdocs = new MkDocs(getcwd() . '/docs');

$mkdocs->setHeaderLink('http://www.example.com');
$mkdocs->setSiteName('Title new');
$mkdocs->setTheme('material'); // You'll have to install the specific themes to your system first

$mkdocs->addPage('Home', 'index.md');
$mkdocs->addPage('About', 'about.md');

$mkdocs->addPage('API Docs', []); // this creates a secondary level, so that you can add pages to this level
$mkdocs->addPage('User', 'user.md', 'API Docs');
$mkdocs->addPage('Data', 'data.md', 'API Docs');

$mkdocs->setPrev('前一页');
$mkdocs->setNext('后一页');
$mkdocs->setPrimaryColor('purple');
$mkdocs->setAccentColor('teal');

$res = $mkdocs->build();

if ($res === true) {
    echo 'Success!';
}
else {
    var_dump($res);
}

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。