0x00-dev/phpdocgen

简单的静态文档生成器

维护者

详情

github.com/0x00-dev/phpdocgen

源代码

问题

安装: 44

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 0

开放问题: 1

语言:HTML

类型:包

v1.2.0 2022-08-29 08:47 UTC

Requires

Requires (Dev)

GPL-3.0-or-later 3fcaf45ce421f4da9d37c792f339fabddbfd53b9

  • 0x00-dev <0x00.dev.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-29 10:09:46 UTC

README

build

PHP静态文档生成器

Image alt

如何使用

  1. 配置生成参数。

通过终端运行

从配置目录运行 vendor/bin/phpdocgen。

项目代码集成

(new \PDG\Component\DocGenerator())
    ->setConfigFile('path_to_your_config/phpdocgen.json')
    ->run();

配置生成器

phpdocgen.json

{
  "src" : "src",
  "dst" : "docs",
  "exclude" : [".", "..", ".git", ".idea"],
  "file_pattern" : "^[a-zA-Z0-9\\_]+\\.php$",
  "removed_prefix" : "",
  "twig_options" : {
    "this_name" :  "PHP static documentation generator"
  },
  "flags" : ["-l"]
}

配置中不一定需要所有参数。