Skip to content

Commit

Permalink
feat(documentator): include:document-list will render headers as li…
Browse files Browse the repository at this point in the history
…nks.
  • Loading branch information
LastDragon-ru committed Nov 28, 2024
1 parent 4aeebdc commit 764061c
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 24 deletions.
6 changes: 3 additions & 3 deletions packages/documentator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,19 @@ composer require lastdragon-ru/lara-asp-documentator
[//]: # (start: preprocess/820df828d96420b5)
[//]: # (warning: Generated automatically. Do not edit.)

## `lara-asp-documentator:commands`
## [`lara-asp-documentator:commands`](<docs/Commands/commands.md>)

Saves help for each command in the `namespace` into a separate file in the `target` directory.

[Read more](<docs/Commands/commands.md>).

## `lara-asp-documentator:preprocess`
## [`lara-asp-documentator:preprocess`](<docs/Commands/preprocess.md>)

Perform one or more task on the file.

[Read more](<docs/Commands/preprocess.md>).

## `lara-asp-documentator:requirements`
## [`lara-asp-documentator:requirements`](<docs/Commands/requirements.md>)

Generates a table with the required versions of PHP/Laravel/etc in Markdown format.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
?>
@foreach ($data->documents as $document)
{{ str_repeat('#', $data->level) }} {!! $document->title !!}
{{ str_repeat('#', $data->level) }} [{!! $document->title !!}](<{{ $document->path }}>)
@if($document->summary)

{!! $document->summary !!}
Expand Down
4 changes: 2 additions & 2 deletions packages/graphql-printer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,13 +227,13 @@ It is highly recommended to use [`lara-asp-graphql`](../graphql/README.md#printe
[//]: # (start: preprocess/c79a463462fd8331)
[//]: # (warning: Generated automatically. Do not edit.)

## `assertGraphQLExportableEquals`
## [`assertGraphQLExportableEquals`](<docs/Assertions/AssertGraphQLExportableEquals.md>)

Exports and compares two GraphQL schemas/types/nodes/etc.

[Read more](<docs/Assertions/AssertGraphQLExportableEquals.md>).

## `assertGraphQLPrintableEquals`
## [`assertGraphQLPrintableEquals`](<docs/Assertions/AssertGraphQLPrintableEquals.md>)

Prints and compares two GraphQL schemas/types/nodes/etc.

Expand Down
20 changes: 10 additions & 10 deletions packages/graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,25 +57,25 @@ php artisan vendor:publish --provider=LastDragon_ru\\LaraASP\\GraphQL\\PackagePr
[//]: # (start: preprocess/bda62d219016136a)
[//]: # (warning: Generated automatically. Do not edit.)

## `@searchBy`
## [`@searchBy`](<docs/Directives/@searchBy.md>)

Probably the most powerful directive to provide search (`where` conditions) for your GraphQL queries.

[Read more](<docs/Directives/@searchBy.md>).

## `@sortBy`
## [`@sortBy`](<docs/Directives/@sortBy.md>)

Probably the most powerful directive to provide sort (`order by` conditions) for your GraphQL queries.

[Read more](<docs/Directives/@sortBy.md>).

## `@stream` 🧪
## [`@stream` 🧪](<docs/Directives/@stream.md>)

Unlike the `@paginate` (and similar) directive, the `@stream` provides a uniform way to perform Offset/Limit and Cursor pagination of Eloquent/Query/Scout builders. Filtering and sorting enabled by default via [`@searchBy`](docs/Directives/@searchBy.md) and [`@sortBy`](docs/Directives/@sortBy.md) directives.

[Read more](<docs/Directives/@stream.md>).

## `@type`
## [`@type`](<docs/Directives/@type.md>)

Converts scalar into GraphQL Type. Similar to Lighthouse's `@scalar` directive, but uses Laravel Container to resolve instance and also supports PHP enums.

Expand All @@ -100,7 +100,7 @@ Converts scalar into GraphQL Type. Similar to Lighthouse's `@scalar` directive,
[//]: # (start: preprocess/e0862296ba011303)
[//]: # (warning: Generated automatically. Do not edit.)
## `JsonString`
## [`JsonString`](<docs/Scalars/JsonString.md>)
Represents [JSON](https://json.org) string.
Expand Down Expand Up @@ -560,31 +560,31 @@ type User {
[//]: # (start: preprocess/c79a463462fd8331)
[//]: # (warning: Generated automatically. Do not edit.)

## `assertGraphQLIntrospectionEquals`
## [`assertGraphQLIntrospectionEquals`](<docs/Assertions/AssertGraphQLIntrospectionEquals.md>)

Compares default public schema (as the client sees it through introspection).

[Read more](<docs/Assertions/AssertGraphQLIntrospectionEquals.md>).

## `assertGraphQLSchemaEquals`
## [`assertGraphQLSchemaEquals`](<docs/Assertions/AssertGraphQLSchemaEquals.md>)

Compares default internal schema (with all directives).

[Read more](<docs/Assertions/AssertGraphQLSchemaEquals.md>).

## `assertGraphQLSchemaNoBreakingChanges`
## [`assertGraphQLSchemaNoBreakingChanges`](<docs/Assertions/AssertGraphQLSchemaNoBreakingChanges.md>)

Checks that no breaking changes in the default internal schema (with all directives).

[Read more](<docs/Assertions/AssertGraphQLSchemaNoBreakingChanges.md>).

## `assertGraphQLSchemaNoDangerousChanges`
## [`assertGraphQLSchemaNoDangerousChanges`](<docs/Assertions/AssertGraphQLSchemaNoDangerousChanges.md>)

Checks that no dangerous changes in the default internal schema (with all directives).

[Read more](<docs/Assertions/AssertGraphQLSchemaNoDangerousChanges.md>).

## `assertGraphQLSchemaValid`
## [`assertGraphQLSchemaValid`](<docs/Assertions/AssertGraphQLSchemaValid.md>)

Validates default internal schema (with all directives). Faster than `lighthouse:validate-schema` command because loads only used directives.

Expand Down
16 changes: 8 additions & 8 deletions packages/testing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,49 +260,49 @@ Disable models events during make/create.
[//]: # (start: preprocess/c79a463462fd8331)
[//]: # (warning: Generated automatically. Do not edit.)

## `assertDatabaseQueryEquals`
## [`assertDatabaseQueryEquals`](<docs/Assertions/AssertDatabaseQueryEquals.md>)

Asserts that SQL Query equals SQL Query.

[Read more](<docs/Assertions/AssertDatabaseQueryEquals.md>).

## `assertJsonMatchesSchema`
## [`assertJsonMatchesSchema`](<docs/Assertions/AssertJsonMatchesSchema.md>)

Asserts that JSON matches [schema](https://json-schema.org/). Validation based on the [Opis JSON Schema](https://github.com/opis/json-schema) package.

[Read more](<docs/Assertions/AssertJsonMatchesSchema.md>).

## `assertPsrResponse`
## [`assertPsrResponse`](<docs/Assertions/AssertPsrResponse.md>)

Asserts that PSR Response satisfies given constraint (we have a lot of built-in [constraints](src/Constraints/Response) and [responses](src/Responses), but, of course, you can create a custom).

[Read more](<docs/Assertions/AssertPsrResponse.md>).

## `assertQueryLogEquals`
## [`assertQueryLogEquals`](<docs/Assertions/AssertQueryLogEquals.md>)

Asserts that `QueryLog` equals `QueryLog`.

[Read more](<docs/Assertions/AssertQueryLogEquals.md>).

## `assertScheduled`
## [`assertScheduled`](<docs/Assertions/AssertScheduled.md>)

Asserts that Schedule contains task.

[Read more](<docs/Assertions/AssertScheduled.md>).

## `assertScoutQueryEquals`
## [`assertScoutQueryEquals`](<docs/Assertions/AssertScoutQueryEquals.md>)

Asserts that Scout Query equals Scout Query.

[Read more](<docs/Assertions/AssertScoutQueryEquals.md>).

## `assertThatResponse` 💀
## [`assertThatResponse` 💀](<docs/Assertions/AssertThatResponse.md>)

Asserts that PSR Response satisfies given constraint (we have a lot of built-in [constraints](src/Constraints/Response) and [responses](src/Responses), but, of course, you can create a custom).

[Read more](<docs/Assertions/AssertThatResponse.md>).

## `assertXmlMatchesSchema`
## [`assertXmlMatchesSchema`](<docs/Assertions/AssertXmlMatchesSchema.md>)

Asserts that XML matches schema [XSD](https://en.wikipedia.org/wiki/XML_Schema_(W3C)) or [Relax NG](https://en.wikipedia.org/wiki/RELAX_NG). Validation based on the standard methods of [`DOMDocument`](https://www.php.net/manual/en/class.domdocument.php) class.

Expand Down

0 comments on commit 764061c

Please sign in to comment.