搜索riimu / sami-config
Sami文档生成器的自动配置提供者
Requires
- php: ^7.1
Requires (Dev)
- riimu/php-cs-fixer-config: ^0.1.0
- sami/sami: ^4.1.1
This package is auto-updated.
Last update: 2024-09-19 21:24:12 UTC
README
我 personally use Sami for generating API documentation for number of my projects. However, to generate that documentation, I need to set up a configuration for each project that only varies slightly per project. Thus I created this composer package that can automatically figure out the configuration and set it up properly for each project.
基本上，通过使用这个自动配置工具，你可以让Sami使用从项目文件中推断出的默认设置进行配置，而不是手动将它们复制到Sami配置中。
使用方法
要将此配置工具添加到您的项目，您应首先通过composer包含它
$ composer require --dev riimu/sami-config
然后您应该在项目根目录中创建一个名为 sami_config.php 的文件，它仅包含以下内容
<?php return require __DIR__ . '/vendor/riimu/sami-config/config.php';
现在，您可以使用 sami_config.php 作为文档生成器的配置，例如。
$ sami.php update sami_config.php
自动配置
源代码
文档将从项目根目录中的 src 目录生成。
主题
生成的文档将不设置主题，但您可以使用环境变量 SAMI_THEME 通过将其设置为包含主题 manifest.yml 的目录路径来设置主题。目录名称和主题名称必须匹配。
标题
文档的标题将从根 README.md 文件中解析，取第一行的文本，该行由markdown标记为标题。然后，将单词 API 添加到它。
例如，如果文档是从这个存储库生成的，标题将是 Riimu的自动Sami配置API。
如果没有确定标题，将抛出异常并中断进程。
版本
配置工具会自动查找存储库中的最新semver稳定标签并检出该标签以生成文档。请注意，如果您在GitHub中将标签创建为发布版本，请记住运行 git fetch 以获取本地标签。
生成文档后，将再次检出之前选择的工怍状态。
如果找不到适用的标签或工作区不干净，无法检出另一个标签，将抛出异常并中断进程。
构建目录
构建目录将设置为项目根目录中的 build/doc，缓存路径为 build/cache。请注意，在生成文档的过程之前，这两个目录都将被完全清除。
远程仓库URL
仓库URL将设置为基于本地git存储库中 origin 远程设置的URL的GitHub仓库URL。
如果未设置有效的GitHub URL作为 origin 的远程URL，将抛出异常并中断进程。
致谢
此软件包版权所有（c）2018 Riikka Kalliomäki。
有关许可和复制信息，请参阅LICENSE。