feat(documentator): include:document-list will render headers as li…

…nks.

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`](<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.
 

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 !!}

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 `>`](<Document B.md>)
 
                 Summary text.
 
                 [Read more](<Document B.md>).
 
-                # Document A
+                # [Document A](<Document A.md>)
 
                 Summary text with special characters `<`, `>`, `&`.
 
@@ -86,19 +86,19 @@ public static function dataProviderInvoke(): array {
             ],
             'Another Directory / Default parameters' => [
                 <<<'MARKDOWN'
-                # `<` Document B `>`
+                # [`<` Document B `>`](<InstructionTest/Document B.md>)
 
                 Summary text.
 
                 [Read more](<InstructionTest/Document B.md>).
 
-                # Document
+                # [Document](<InstructionTest/Document.md>)
 
                 Document summary.
 
                 [Read more](<InstructionTest/Document.md>).
 
-                # Document A
+                # [Document A](<InstructionTest/Document A.md>)
 
                 Summary text with special characters `<`, `>`, `&`.
 
@@ -112,19 +112,19 @@ public static function dataProviderInvoke(): array {
             ],
             'Nested Directories'                     => [
                 <<<'MARKDOWN'
-                # Nested B
+                # [Nested B](<B/Document B.md>)
 
                 Summary [text](../Document.md).
 
                 [Read more](<B/Document B.md>).
 
-                # Nested A
+                # [Nested A](<A/Document A.md>)
 
                 Summary [text](../Document.md).
 
                 [Read more](<A/Document A.md>).
 
-                # Document C
+                # [Document C](<Document C.md>)
 
                 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 `>`](<Document B.md>)
 
                 Summary text.
 
                 [Read more](<Document B.md>).
 
-                ## Document A
+                ## [Document A](<Document A.md>)
 
                 Summary text with special characters `<`, `>`, `&`.
 
@@ -162,13 +162,13 @@ public static function dataProviderInvoke(): array {
             ],
             'Level `0`'                              => [
                 <<<'MARKDOWN'
-                ### `<` Document B `>`
+                ### [`<` Document B `>`](<Document B.md>)
 
                 Summary text.
 
                 [Read more](<Document B.md>).
 
-                ### Document A
+                ### [Document A](<Document A.md>)
 
                 Summary text with special characters `<`, `>`, `&`.
 
@@ -186,13 +186,13 @@ public static function dataProviderInvoke(): array {
             ],
             'Level `<number>`'                       => [
                 <<<'MARKDOWN'
-                #### `<` Document B `>`
+                #### [`<` Document B `>`](<Document B.md>)
 
                 Summary text.
 
                 [Read more](<Document B.md>).
 
-                #### Document A
+                #### [Document A](<Document A.md>)
 
                 Summary text with special characters `<`, `>`, `&`.
 

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`](<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.
 

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`](<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.
 
@@ -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.
 
@@ -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.
 

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`](<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.