Skip to content

Commit 96617d0

Browse files
Fix markdown formatting (#10261)
1 parent 6a0eec9 commit 96617d0

19 files changed

+83
-84
lines changed

Diff for: requests.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ Route::get('/', function (ServerRequestInterface $request) {
276276
});
277277
```
278278

279-
> [!NOTE]
279+
> [!NOTE]
280280
> If you return a PSR-7 response instance from a route or controller, it will automatically be converted back to a Laravel response instance and be displayed by the framework.
281281
282282
<a name="input"></a>
@@ -456,7 +456,7 @@ $input = $request->except(['credit_card']);
456456
$input = $request->except('credit_card');
457457
```
458458

459-
> [!WARNING]
459+
> [!WARNING]
460460
> The `only` method returns all of the key / value pairs that you request; however, it will not return key / value pairs that are not present on the request.
461461
462462
<a name="input-presence"></a>
@@ -754,7 +754,7 @@ $path = $request->photo->storeAs('images', 'filename.jpg');
754754
$path = $request->photo->storeAs('images', 'filename.jpg', 's3');
755755
```
756756

757-
> [!NOTE]
757+
> [!NOTE]
758758
> For more information about file storage in Laravel, check out the complete [file storage documentation](/docs/{{version}}/filesystem).
759759
760760
<a name="configuring-trusted-proxies"></a>
@@ -786,7 +786,7 @@ In addition to configuring the trusted proxies, you may also configure the proxy
786786
})
787787
```
788788

789-
> [!NOTE]
789+
> [!NOTE]
790790
> If you are using AWS Elastic Load Balancing, the `headers` value should be `Request::HEADER_X_FORWARDED_AWS_ELB`. If your load balancer uses the standard `Forwarded` header from [RFC 7239](https://www.rfc-editor.org/rfc/rfc7239#section-4), the `headers` value should be `Request::HEADER_FORWARDED`. For more information on the constants that may be used in the `headers` value, check out Symfony's documentation on [trusting proxies](https://symfony.com/doc/7.0/deployment/proxies.html).
791791
792792
<a name="trusting-all-proxies"></a>

Diff for: responses.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Route::get('/', function () {
3939
});
4040
```
4141

42-
> [!NOTE]
42+
> [!NOTE]
4343
> Did you know you can also return [Eloquent collections](/docs/{{version}}/eloquent-collections) from your routes or controllers? They will automatically be converted to JSON. Give it a shot!
4444
4545
<a name="response-objects"></a>
@@ -345,7 +345,7 @@ return response()->download($pathToFile);
345345
return response()->download($pathToFile, $name, $headers);
346346
```
347347

348-
> [!WARNING]
348+
> [!WARNING]
349349
> Symfony HttpFoundation, which manages file downloads, requires the file being downloaded to have an ASCII filename.
350350
351351
<a name="file-responses"></a>

Diff for: reverb.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Connection activity is recorded by polling for new updates on a periodic basis.
197197

198198
Due to the long-running nature of WebSocket servers, you may need to make some optimizations to your server and hosting environment to ensure your Reverb server can effectively handle the optimal number of connections for the resources available on your server.
199199

200-
> [!NOTE]
200+
> [!NOTE]
201201
> If your site is managed by [Laravel Forge](https://forge.laravel.com), you may automatically optimize your server for Reverb directly from the "Application" panel. By enabling the Reverb integration, Forge will ensure your server is production-ready, including installing any required extensions and increasing the allowed number of connections.
202202
203203
<a name="open-files"></a>
@@ -259,7 +259,7 @@ server {
259259
}
260260
```
261261

262-
> [!WARNING]
262+
> [!WARNING]
263263
> Reverb listens for WebSocket connections at `/app` and handles API requests at `/apps`. You should ensure the web server handling Reverb requests can serve both of these URIs. If you are using [Laravel Forge](https://forge.laravel.com) to manage your servers, your Reverb server will be correctly configured by default.
264264
265265
Typically, web servers are configured to limit the number of allowed connections in order to prevent overloading the server. To increase the number of allowed connections on an Nginx web server to 10,000, the `worker_rlimit_nofile` and `worker_connections` values of the `nginx.conf` file should be updated:

Diff for: routing.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Route::any('/', function () {
109109
});
110110
```
111111

112-
> [!NOTE]
112+
> [!NOTE]
113113
> When defining multiple routes that share the same URI, routes using the `get`, `post`, `put`, `patch`, `delete`, and `options` methods should be defined before routes using the `any`, `match`, and `redirect` methods. This ensures the incoming request is matched with the correct route.
114114
115115
<a name="dependency-injection"></a>
@@ -158,7 +158,7 @@ Or, you may use the `Route::permanentRedirect` method to return a `301` status c
158158
Route::permanentRedirect('/here', '/there');
159159
```
160160

161-
> [!WARNING]
161+
> [!WARNING]
162162
> When using route parameters in redirect routes, the following parameters are reserved by Laravel and cannot be used: `destination` and `status`.
163163
164164
<a name="view-routes"></a>
@@ -172,7 +172,7 @@ Route::view('/welcome', 'welcome');
172172
Route::view('/welcome', 'welcome', ['name' => 'Taylor']);
173173
```
174174

175-
> [!WARNING]
175+
> [!WARNING]
176176
> When using route parameters in view routes, the following parameters are reserved by Laravel and cannot be used: `view`, `data`, `status`, and `headers`.
177177
178178
<a name="listing-your-routes"></a>
@@ -402,7 +402,7 @@ Route::get('/search/{search}', function (string $search) {
402402
})->where('search', '.*');
403403
```
404404

405-
> [!WARNING]
405+
> [!WARNING]
406406
> Encoded forward slashes are only supported within the last route segment.
407407
408408
<a name="named-routes"></a>
@@ -425,7 +425,7 @@ Route::get(
425425
)->name('profile');
426426
```
427427

428-
> [!WARNING]
428+
> [!WARNING]
429429
> Route names should always be unique.
430430
431431
<a name="generating-urls-to-named-routes"></a>
@@ -465,7 +465,7 @@ $url = route('profile', ['id' => 1, 'photos' => 'yes']);
465465
// /user/1/profile?photos=yes
466466
```
467467

468-
> [!NOTE]
468+
> [!NOTE]
469469
> Sometimes, you may wish to specify request-wide default values for URL parameters, such as the current locale. To accomplish this, you may use the [`URL::defaults` method](/docs/{{version}}/urls#default-values).
470470
471471
<a name="inspecting-the-current-route"></a>
@@ -544,7 +544,7 @@ Route::domain('{account}.example.com')->group(function () {
544544
});
545545
```
546546

547-
> [!WARNING]
547+
> [!WARNING]
548548
> In order to ensure your subdomain routes are reachable, you should register subdomain routes before registering root domain routes. This will prevent root domain routes from overwriting subdomain routes which have the same URI path.
549549
550550
<a name="route-group-prefixes"></a>
@@ -1023,7 +1023,7 @@ php artisan config:publish cors
10231023

10241024
This command will place a `cors.php` configuration file within your application's `config` directory.
10251025

1026-
> [!NOTE]
1026+
> [!NOTE]
10271027
> For more information on CORS and CORS headers, please consult the [MDN web documentation on CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#The_HTTP_response_headers).
10281028
10291029
<a name="route-caching"></a>

Diff for: sail.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Finally, you may start Sail. To continue learning how to use Sail, please contin
6666
./vendor/bin/sail up
6767
```
6868

69-
> [!WARNING]
69+
> [!WARNING]
7070
> If you are using Docker Desktop for Linux, you should use the `default` Docker context by executing the following command: `docker context use default`.
7171
7272
<a name="adding-additional-services"></a>
@@ -300,7 +300,7 @@ AWS_URL=http://localhost:9000/local
300300

301301
You may create buckets via the MinIO console, which is available at `http://localhost:8900`. The default username for the MinIO console is `sail` while the default password is `password`.
302302

303-
> [!WARNING]
303+
> [!WARNING]
304304
> Generating temporary storage URLs via the `temporaryUrl` method is not supported when using MinIO.
305305
306306
<a name="running-tests"></a>
@@ -480,7 +480,7 @@ If you would like to choose the subdomain for your shared site, you may provide
480480
sail share --subdomain=my-sail-site
481481
```
482482

483-
> [!NOTE]
483+
> [!NOTE]
484484
> The `share` command is powered by [Expose](https://github.com/beyondcode/expose), an open source tunneling service by [BeyondCode](https://beyondco.de).
485485

486486
<a name="debugging-with-xdebug"></a>
@@ -551,7 +551,7 @@ To debug your application while interacting with the application via a web brows
551551

552552
If you're using PhpStorm, please review JetBrains' documentation regarding [zero-configuration debugging](https://www.jetbrains.com/help/phpstorm/zero-configuration-debugging.html).
553553

554-
> [!WARNING]
554+
> [!WARNING]
555555
> Laravel Sail relies on `artisan serve` to serve your application. The `artisan serve` command only accepts the `XDEBUG_CONFIG` and `XDEBUG_MODE` variables as of Laravel version 8.53.0. Older versions of Laravel (8.52.0 and below) do not support these variables and will not accept debug connections.
556556

557557
<a name="sail-customization"></a>

Diff for: sanctum.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ For this feature, Sanctum does not use tokens of any kind. Instead, Sanctum uses
4848

4949
Sanctum will only attempt to authenticate using cookies when the incoming request originates from your own SPA frontend. When Sanctum examines an incoming HTTP request, it will first check for an authentication cookie and, if none is present, Sanctum will then examine the `Authorization` header for a valid API token.
5050

51-
> [!NOTE]
51+
> [!NOTE]
5252
> It is perfectly fine to use Sanctum only for API token authentication or only for SPA authentication. Just because you use Sanctum does not mean you are required to use both features it offers.
5353
5454
<a name="installation"></a>
@@ -97,7 +97,7 @@ public function boot(): void
9797
<a name="api-token-authentication"></a>
9898
## API Token Authentication
9999

100-
> [!NOTE]
100+
> [!NOTE]
101101
> You should not use API tokens to authenticate your own first-party SPA. Instead, use Sanctum's built-in [SPA authentication features](#spa-authentication).
102102
103103
<a name="issuing-api-tokens"></a>
@@ -269,7 +269,7 @@ Sanctum also exists to provide a simple method of authenticating single page app
269269

270270
For this feature, Sanctum does not use tokens of any kind. Instead, Sanctum uses Laravel's built-in cookie based session authentication services. This approach to authentication provides the benefits of CSRF protection, session authentication, as well as protects against leakage of the authentication credentials via XSS.
271271

272-
> [!WARNING]
272+
> [!WARNING]
273273
> In order to authenticate, your SPA and API must share the same top-level domain. However, they may be placed on different subdomains. Additionally, you should ensure that you send the `Accept: application/json` header and either the `Referer` or `Origin` header with your request.
274274
275275
<a name="spa-configuration"></a>
@@ -280,7 +280,7 @@ For this feature, Sanctum does not use tokens of any kind. Instead, Sanctum uses
280280

281281
First, you should configure which domains your SPA will be making requests from. You may configure these domains using the `stateful` configuration option in your `sanctum` configuration file. This configuration setting determines which domains will maintain "stateful" authentication using Laravel session cookies when making requests to your API.
282282

283-
> [!WARNING]
283+
> [!WARNING]
284284
> If you are accessing your application via a URL that includes a port (`127.0.0.1:8000`), you should ensure that you include the port number with the domain.
285285
286286
<a name="sanctum-middleware"></a>
@@ -345,7 +345,7 @@ If the login request is successful, you will be authenticated and subsequent req
345345

346346
Of course, if your user's session expires due to lack of activity, subsequent requests to the Laravel application may receive a 401 or 419 HTTP error response. In this case, you should redirect the user to your SPA's login page.
347347

348-
> [!WARNING]
348+
> [!WARNING]
349349
> You are free to write your own `/login` endpoint; however, you should ensure that it authenticates the user using the standard, [session based authentication services that Laravel provides](/docs/{{version}}/authentication#authenticating-users). Typically, this means using the `web` authentication guard.
350350
351351
<a name="protecting-spa-routes"></a>
@@ -444,7 +444,7 @@ Route::post('/sanctum/token', function (Request $request) {
444444

445445
When the mobile application uses the token to make an API request to your application, it should pass the token in the `Authorization` header as a `Bearer` token.
446446

447-
> [!NOTE]
447+
> [!NOTE]
448448
> When issuing tokens for a mobile application, you are also free to specify [token abilities](#token-abilities).
449449
450450
<a name="protecting-mobile-api-routes"></a>

Diff for: scheduling.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ If you are repeatedly assigning the same timezone to all of your scheduled tasks
319319
'schedule_timezone' => 'America/Chicago',
320320
```
321321

322-
> [!WARNING]
322+
> [!WARNING]
323323
> Remember that some timezones utilize daylight savings time. When daylight saving time changes occur, your scheduled task may run twice or even not run at all. For this reason, we recommend avoiding timezone scheduling when possible.
324324
325325
<a name="preventing-task-overlaps"></a>
@@ -346,7 +346,7 @@ Behind the scenes, the `withoutOverlapping` method utilizes your application's [
346346
<a name="running-tasks-on-one-server"></a>
347347
### Running Tasks on One Server
348348

349-
> [!WARNING]
349+
> [!WARNING]
350350
> To utilize this feature, your application must be using the `database`, `memcached`, `dynamodb`, or `redis` cache driver as your application's default cache driver. In addition, all servers must be communicating with the same central cache server.
351351
352352
If your application's scheduler is running on multiple servers, you may limit a scheduled job to only execute on a single server. For instance, assume you have a scheduled task that generates a new report every Friday night. If the task scheduler is running on three worker servers, the scheduled task will run on all three servers and generate the report three times. Not good!
@@ -401,7 +401,7 @@ Schedule::command('analytics:report')
401401
->runInBackground();
402402
```
403403

404-
> [!WARNING]
404+
> [!WARNING]
405405
> The `runInBackground` method may only be used when scheduling tasks via the `command` and `exec` methods.
406406
407407
<a name="maintenance-mode"></a>
@@ -526,7 +526,7 @@ Schedule::command('report:generate')
526526
->emailOutputOnFailure('[email protected]');
527527
```
528528

529-
> [!WARNING]
529+
> [!WARNING]
530530
> The `emailOutputTo`, `emailOutputOnFailure`, `sendOutputTo`, and `appendOutputTo` methods are exclusive to the `command` and `exec` methods.
531531
532532
<a name="task-hooks"></a>
@@ -602,7 +602,7 @@ The `pingBeforeIf`,`thenPingIf`,`pingOnSuccessIf`, and `pingOnFailureIf` methods
602602
Schedule::command('emails:send')
603603
->daily()
604604
->pingBeforeIf($condition, $url)
605-
->thenPingIf($condition, $url);
605+
->thenPingIf($condition, $url);
606606

607607
Schedule::command('emails:send')
608608
->daily()

Diff for: seeding.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
Laravel includes the ability to seed your database with data using seed classes. All seed classes are stored in the `database/seeders` directory. By default, a `DatabaseSeeder` class is defined for you. From this class, you may use the `call` method to run other seed classes, allowing you to control the seeding order.
1414

15-
> [!NOTE]
15+
> [!NOTE]
1616
> [Mass assignment protection](/docs/{{version}}/eloquent#mass-assignment) is automatically disabled during database seeding.
1717
1818
<a name="writing-seeders"></a>
@@ -54,7 +54,7 @@ class DatabaseSeeder extends Seeder
5454
}
5555
```
5656

57-
> [!NOTE]
57+
> [!NOTE]
5858
> You may type-hint any dependencies you need within the `run` method's signature. They will automatically be resolved via the Laravel [service container](/docs/{{version}}/container).
5959
6060
<a name="using-model-factories"></a>

Diff for: session.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The session `driver` configuration option defines where session data will be sto
3939

4040
</div>
4141

42-
> [!NOTE]
42+
> [!NOTE]
4343
> The array driver is primarily used during [testing](/docs/{{version}}/testing) and prevents the data stored in the session from being persisted.
4444
4545
<a name="driver-prerequisites"></a>
@@ -61,7 +61,7 @@ php artisan migrate
6161

6262
Before using Redis sessions with Laravel, you will need to either install the PhpRedis PHP extension via PECL or install the `predis/predis` package (~1.0) via Composer. For more information on configuring Redis, consult Laravel's [Redis documentation](/docs/{{version}}/redis#configuration).
6363

64-
> [!NOTE]
64+
> [!NOTE]
6565
> The `SESSION_CONNECTION` environment variable, or the `connection` option in the `session.php` configuration file, may be used to specify which Redis connection is used for session storage.
6666
6767
<a name="interacting-with-the-session"></a>
@@ -126,7 +126,7 @@ Route::get('/home', function () {
126126
});
127127
```
128128

129-
> [!NOTE]
129+
> [!NOTE]
130130
> There is little practical difference between using the session via an HTTP request instance versus using the global `session` helper. Both methods are [testable](/docs/{{version}}/testing) via the `assertSessionHas` method which is available in all of your test cases.
131131
132132
<a name="retrieving-all-session-data"></a>
@@ -280,7 +280,7 @@ $request->session()->invalidate();
280280
<a name="session-blocking"></a>
281281
## Session Blocking
282282

283-
> [!WARNING]
283+
> [!WARNING]
284284
> To utilize session blocking, your application must be using a cache driver that supports [atomic locks](/docs/{{version}}/cache#atomic-locks). Currently, those cache drivers include the `memcached`, `dynamodb`, `redis`, `mongodb` (included in the official `mongodb/laravel-mongodb` package), `database`, `file`, and `array` drivers. In addition, you may not use the `cookie` session driver.
285285
286286
By default, Laravel allows requests using the same session to execute concurrently. So, for example, if you use a JavaScript HTTP library to make two HTTP requests to your application, they will both execute at the same time. For many applications, this is not a problem; however, session data loss can occur in a small subset of applications that make concurrent requests to two different application endpoints which both write data to the session.

Diff for: socialite.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
In addition to typical, form based authentication, Laravel also provides a simple, convenient way to authenticate with OAuth providers using [Laravel Socialite](https://github.com/laravel/socialite). Socialite currently supports authentication via Facebook, X, LinkedIn, Google, GitHub, GitLab, Bitbucket, and Slack.
1919

20-
> [!NOTE]
20+
> [!NOTE]
2121
> Adapters for other platforms are available via the community driven [Socialite Providers](https://socialiteproviders.com/) website.
2222
2323
<a name="installation"></a>
@@ -49,7 +49,7 @@ These credentials should be placed in your application's `config/services.php` c
4949
],
5050
```
5151

52-
> [!NOTE]
52+
> [!NOTE]
5353
> If the `redirect` option contains a relative path, it will automatically be resolved to a fully qualified URL.
5454
5555
<a name="authentication"></a>
@@ -104,7 +104,7 @@ Route::get('/auth/callback', function () {
104104
});
105105
```
106106

107-
> [!NOTE]
107+
> [!NOTE]
108108
> For more information regarding what user information is available from specific OAuth providers, please consult the documentation on [retrieving user details](#retrieving-user-details).
109109
110110
<a name="access-scopes"></a>
@@ -172,7 +172,7 @@ return Socialite::driver('google')
172172
->redirect();
173173
```
174174

175-
> [!WARNING]
175+
> [!WARNING]
176176
> When using the `with` method, be careful not to pass any reserved keywords such as `state` or `response_type`.
177177
178178
<a name="retrieving-user-details"></a>

Diff for: starter-kits.md

-1
Original file line numberDiff line numberDiff line change
@@ -386,4 +386,3 @@ php artisan vendor:publish --tag=laravel-mail
386386
```
387387

388388
This will generate several files in `resources/views/vendor/mail`. You can modify any of these files as well as the `resources/views/vendor/mail/themes/default.css` file to change the look and appearance of the default email template.
389-

Diff for: structure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ By default, the `app` directory contains the `Http`, `Models`, and `Providers` d
106106

107107
Both the `Console` and `Http` directories are further explained in their respective sections below, but think of the `Console` and `Http` directories as providing an API into the core of your application. The HTTP protocol and CLI are both mechanisms to interact with your application, but do not actually contain application logic. In other words, they are two ways of issuing commands to your application. The `Console` directory contains all of your Artisan commands, while the `Http` directory contains your controllers, middleware, and requests.
108108

109-
> [!NOTE]
109+
> [!NOTE]
110110
> Many of the classes in the `app` directory can be generated by Artisan via commands. To review the available commands, run the `php artisan list make` command in your terminal.
111111
112112
<a name="the-broadcasting-directory"></a>

Diff for: telescope.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ protected function gate(): void
151151
}
152152
```
153153

154-
> [!WARNING]
154+
> [!WARNING]
155155
> You should ensure you change your `APP_ENV` environment variable to `production` in your production environment. Otherwise, your Telescope installation will be publicly available.
156156
157157
<a name="upgrading-telescope"></a>

0 commit comments

Comments
 (0)