|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +use Artisense\Enums\DocumentationVersion; |
| 6 | +use Artisense\Enums\SearchPreference; |
| 7 | +use Artisense\Formatters\BasicMarkdownFormatter; |
| 8 | + |
| 9 | +return [ |
| 10 | + |
| 11 | + /* |
| 12 | + |-------------------------------------------------------------------------- |
| 13 | + | Documentation version |
| 14 | + |-------------------------------------------------------------------------- |
| 15 | + | |
| 16 | + | Specifies the version of the documentation to use, with both numbered |
| 17 | + | versions and master available. By default, the most recent numbered |
| 18 | + | is used if no version is specified while attempting to download. |
| 19 | + | |
| 20 | + */ |
| 21 | + |
| 22 | + 'versions' => DocumentationVersion::VERSION_12, |
| 23 | + |
| 24 | + /* |
| 25 | + |-------------------------------------------------------------------------- |
| 26 | + | Output Formatter |
| 27 | + |-------------------------------------------------------------------------- |
| 28 | + | |
| 29 | + | Specifies the optional formatter that the output should use for markdown. |
| 30 | + | Markdown content will be returned from artisense and can be formatted |
| 31 | + | Using any formatting tools installed wherever artisense is running. |
| 32 | + | |
| 33 | + */ |
| 34 | + |
| 35 | + 'formatter' => BasicMarkdownFormatter::class, |
| 36 | + |
| 37 | + /* |
| 38 | + |-------------------------------------------------------------------------- |
| 39 | + | Search Preference |
| 40 | + |-------------------------------------------------------------------------- |
| 41 | + | |
| 42 | + | Specifies the search preferences to use when querying for documentation. |
| 43 | + | Ordered searches are used by default, returning results using ordered |
| 44 | + | phrase matching. You may choose your preference to adjust results. |
| 45 | + | |
| 46 | + */ |
| 47 | + |
| 48 | + 'search' => [ |
| 49 | + 'preference' => SearchPreference::ORDERED, |
| 50 | + 'proximity' => 10, |
| 51 | + ], |
| 52 | + |
| 53 | + /* |
| 54 | + |-------------------------------------------------------------------------- |
| 55 | + | Retain Artifacts |
| 56 | + |-------------------------------------------------------------------------- |
| 57 | + | |
| 58 | + | Specifies the artifact retention policy artisense should use when processing |
| 59 | + | Laravel documentation. If set to true, documentation markdown files along |
| 60 | + | zip archives will be retained within the storage folder during install. |
| 61 | + | |
| 62 | + */ |
| 63 | + |
| 64 | + 'retain_artifacts' => true, |
| 65 | + |
| 66 | +]; |
0 commit comments