Skip to content

Commit

Permalink
Fixed mkdocs order, README wrong use and missing lines
Browse files Browse the repository at this point in the history
  • Loading branch information
PopNatanael committed Apr 12, 2024
1 parent b21a5c9 commit 8c59ed9
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ jobs:
uses: dotkernel/documentation-theme/github-actions/docs@main
env:
DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ Next, register the package's `ConfigProvider` to your application config.

Note : Make sure to register the package under the `// DK packages` section.

After registering the package, add it to the middleware stack in ``config/pipeline.php`` after `$app->pipe(RouteMiddleware::class);`
After registering the package, add it to the middleware stack in `config/pipeline.php` after `$app->pipe(RouteMiddleware::class);`

$app->pipe(RouteMiddleware::class);
$app->pipe(\Dot\ResponseHeader\Middleware\ResponseHeaderMiddleware::class);

Create a new file ``response-header.global.php`` in ``config/autoload`` with the below configuration array :
Create a new file `response-header.global.php` in `config/autoload` with the below configuration array :

<?php
return [
Expand Down Expand Up @@ -65,9 +65,9 @@ Create a new file ``response-header.global.php`` in ``config/autoload`` with the
]
];

Because headers are matched with route names, we can have custom response headers for every request, by defining new headers under the ``*`` key.
Because headers are matched with route names, we can have custom response headers for every request, by defining new headers under the `*` key.

All headers under ``*`` will be set for every response.
All headers under `*` will be set for every response.

To add response headers for a specific set of routes, define a new array using the route name as the array key.

Expand All @@ -84,4 +84,4 @@ Example :

// This will set a new header named UserCustomHeader with the UserCustomHeader-Value value for any route name matching 'user'

To overwrite an existing header use ``overwrite => true``.
To overwrite an existing header use `overwrite => true`.
2 changes: 1 addition & 1 deletion docs/book/v3/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Install dotkernel/dot-response-header by executing the following Composer command in your project directory:

$ composer require dotkernel/dot-response-header
composer require dotkernel/dot-response-header
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ nav:
- v3:
- Overview: v3/overview.md
- Installation: v3/installation.md
- Usage: v3/usage.md
- Configuration: v3/configuration.md
- Usage: v3/usage.md
site_name: dot-response-header
site_description: "DotKernel's middleware for setting and overwriting custom response headers."
repo_url: "https://github.com/dotkernel/dot-response-header"
Expand Down

0 comments on commit 8c59ed9

Please sign in to comment.