From 8e0299ed680305b62361961f1dacae549fb08f68 Mon Sep 17 00:00:00 2001 From: Aleksei Lebedev <1329824+LastDragon-ru@users.noreply.github.com> Date: Thu, 28 Nov 2024 10:21:33 +0400 Subject: [PATCH] feat(documentator): `include:document-list` will render headers as links. --- packages/documentator/README.md | 6 ++-- .../views/document-list/default.blade.php | 2 +- .../IncludeDocumentList/InstructionTest.php | 28 +++++++++---------- packages/graphql-printer/README.md | 4 +-- packages/graphql/README.md | 20 ++++++------- packages/testing/README.md | 16 +++++------ 6 files changed, 38 insertions(+), 38 deletions(-) diff --git a/packages/documentator/README.md b/packages/documentator/README.md index b69973b0..f61d37aa 100644 --- a/packages/documentator/README.md +++ b/packages/documentator/README.md @@ -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`]() Saves help for each command in the `namespace` into a separate file in the `target` directory. [Read more](). -## `lara-asp-documentator:preprocess` +## [`lara-asp-documentator:preprocess`]() Perform one or more task on the file. [Read more](). -## `lara-asp-documentator:requirements` +## [`lara-asp-documentator:requirements`]() Generates a table with the required versions of PHP/Laravel/etc in Markdown format. diff --git a/packages/documentator/defaults/views/document-list/default.blade.php b/packages/documentator/defaults/views/document-list/default.blade.php index aff85a10..7085508b 100644 --- a/packages/documentator/defaults/views/document-list/default.blade.php +++ b/packages/documentator/defaults/views/document-list/default.blade.php @@ -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 !!} diff --git a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/InstructionTest.php b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/InstructionTest.php index d9539386..d73766cb 100644 --- a/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/InstructionTest.php +++ b/packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeDocumentList/InstructionTest.php @@ -66,13 +66,13 @@ public static function dataProviderInvoke(): array { return [ 'Same Directory / Default parameters' => [ <<<'MARKDOWN' - # `<` Document B `>` + # [`<` Document B `>`]() Summary text. [Read more](). - # Document A + # [Document A]() Summary text with special characters `<`, `>`, `&`. @@ -86,19 +86,19 @@ public static function dataProviderInvoke(): array { ], 'Another Directory / Default parameters' => [ <<<'MARKDOWN' - # `<` Document B `>` + # [`<` Document B `>`]() Summary text. [Read more](). - # Document + # [Document]() Document summary. [Read more](). - # Document A + # [Document A]() Summary text with special characters `<`, `>`, `&`. @@ -112,19 +112,19 @@ public static function dataProviderInvoke(): array { ], 'Nested Directories' => [ <<<'MARKDOWN' - # Nested B + # [Nested B]() Summary [text](../Document.md). [Read more](). - # Nested A + # [Nested A]() Summary [text](../Document.md). [Read more](). - # Document C + # [Document C]() Summary [text](../Document.md) summary [link](../Document.md "title") and summary and self and self. @@ -138,13 +138,13 @@ public static function dataProviderInvoke(): array { ], 'Level `null`' => [ <<<'MARKDOWN' - ## `<` Document B `>` + ## [`<` Document B `>`]() Summary text. [Read more](). - ## Document A + ## [Document A]() Summary text with special characters `<`, `>`, `&`. @@ -162,13 +162,13 @@ public static function dataProviderInvoke(): array { ], 'Level `0`' => [ <<<'MARKDOWN' - ### `<` Document B `>` + ### [`<` Document B `>`]() Summary text. [Read more](). - ### Document A + ### [Document A]() Summary text with special characters `<`, `>`, `&`. @@ -186,13 +186,13 @@ public static function dataProviderInvoke(): array { ], 'Level ``' => [ <<<'MARKDOWN' - #### `<` Document B `>` + #### [`<` Document B `>`]() Summary text. [Read more](). - #### Document A + #### [Document A]() Summary text with special characters `<`, `>`, `&`. diff --git a/packages/graphql-printer/README.md b/packages/graphql-printer/README.md index 6090c66e..84f4ab7e 100644 --- a/packages/graphql-printer/README.md +++ b/packages/graphql-printer/README.md @@ -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`]() Exports and compares two GraphQL schemas/types/nodes/etc. [Read more](). -## `assertGraphQLPrintableEquals` +## [`assertGraphQLPrintableEquals`]() Prints and compares two GraphQL schemas/types/nodes/etc. diff --git a/packages/graphql/README.md b/packages/graphql/README.md index 5e58f754..4dd3713d 100644 --- a/packages/graphql/README.md +++ b/packages/graphql/README.md @@ -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`]() Probably the most powerful directive to provide search (`where` conditions) for your GraphQL queries. [Read more](). -## `@sortBy` +## [`@sortBy`]() Probably the most powerful directive to provide sort (`order by` conditions) for your GraphQL queries. [Read more](). -## `@stream` ๐Ÿงช +## [`@stream` ๐Ÿงช]() 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](). -## `@type` +## [`@type`]() Converts scalar into GraphQL Type. Similar to Lighthouse's `@scalar` directive, but uses Laravel Container to resolve instance and also supports PHP enums. @@ -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`]() Represents [JSON](https://json.org) string. @@ -560,31 +560,31 @@ type User { [//]: # (start: preprocess/c79a463462fd8331) [//]: # (warning: Generated automatically. Do not edit.) -## `assertGraphQLIntrospectionEquals` +## [`assertGraphQLIntrospectionEquals`]() Compares default public schema (as the client sees it through introspection). [Read more](). -## `assertGraphQLSchemaEquals` +## [`assertGraphQLSchemaEquals`]() Compares default internal schema (with all directives). [Read more](). -## `assertGraphQLSchemaNoBreakingChanges` +## [`assertGraphQLSchemaNoBreakingChanges`]() Checks that no breaking changes in the default internal schema (with all directives). [Read more](). -## `assertGraphQLSchemaNoDangerousChanges` +## [`assertGraphQLSchemaNoDangerousChanges`]() Checks that no dangerous changes in the default internal schema (with all directives). [Read more](). -## `assertGraphQLSchemaValid` +## [`assertGraphQLSchemaValid`]() Validates default internal schema (with all directives). Faster than `lighthouse:validate-schema` command because loads only used directives. diff --git a/packages/testing/README.md b/packages/testing/README.md index 3036cfb1..a1ada7c8 100644 --- a/packages/testing/README.md +++ b/packages/testing/README.md @@ -260,49 +260,49 @@ Disable models events during make/create. [//]: # (start: preprocess/c79a463462fd8331) [//]: # (warning: Generated automatically. Do not edit.) -## `assertDatabaseQueryEquals` +## [`assertDatabaseQueryEquals`]() Asserts that SQL Query equals SQL Query. [Read more](). -## `assertJsonMatchesSchema` +## [`assertJsonMatchesSchema`]() 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](). -## `assertPsrResponse` +## [`assertPsrResponse`]() 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](). -## `assertQueryLogEquals` +## [`assertQueryLogEquals`]() Asserts that `QueryLog` equals `QueryLog`. [Read more](). -## `assertScheduled` +## [`assertScheduled`]() Asserts that Schedule contains task. [Read more](). -## `assertScoutQueryEquals` +## [`assertScoutQueryEquals`]() Asserts that Scout Query equals Scout Query. [Read more](). -## `assertThatResponse` ๐Ÿ’€ +## [`assertThatResponse` ๐Ÿ’€]() 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](). -## `assertXmlMatchesSchema` +## [`assertXmlMatchesSchema`]() 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.