objective-php / docu-mentor

用于生成Objective-php的Markdown文档的工具

维护者

详细信息

github.com/objective-php/docu-mentor

主页

源代码

问题

安装: 154

依赖: 2

建议: 0

安全: 0

星标: 0

关注者: 6

分支: 0

开放问题: 1

v1.0.4 2019-06-02 15:12 UTC

Requires

Requires (Dev)

GPL-3.0 243fc7e76ab0cc9c7567e0bd3699adca95a96200

  • Louis Cuny <louis-cuny.woop@gmx.fr>

markdowndocobjective php

This package is auto-updated.

Last update: 2024-08-29 04:42:25 UTC

README

简介

我们一直希望使我们的框架Objective PHP对任何感兴趣并获得使用它的人可用。我们尝试以多种方式编写文档，但最终选择编写一个工具，为每个组件生成自定义Markdown文档。

描述

Docu-mentor是一个用于生成包文档的CLI工具。

安装

Composer

使用Composer安装库并准备使用它的最简单方法是运行以下命令

composer require objective-php/docu-mentor

该命令将在./vendor/bin中可用

配置指令文档指南

对于

如何使用

用法

php docu [OPTIONS]    

    -i, --init      Generate the docs/.md files 
    -c, --configs   Update the config-directive doc file
    -v, --verbose   Shows the errors
    -vv, -vvv       Shows the errors more expressly
    -f, --force     Overwrite the docs
    -h,-u, --help,--usage   
                    Show this message
     --config-dir=[path]
                    Specify a custom path for the configs   
     --docs-dir=[path]   
                    Specify a custom path for output directory
     --composer-file=[path]   
                    Specify a custom path for composer.json

示例

初始化整个文档

    php docu -ic

重写配置文档

    php docu -c -v

重写和调试配置

    php docu -c -vvv

重置文档

    php docu -i --force

自定义路径

    php docu -ic --config-dir=./docs/ --docs-dir=./Config

整个文档

完整文档可在此处找到 objective-php.org