Skip to content

Commit 6a0eec9

Browse files
Fix markdown formatting (#10260)
1 parent a89581b commit 6a0eec9

21 files changed

+124
-124
lines changed

mail.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ public function content(): Content
379379
}
380380
```
381381

382-
> [!NOTE]
382+
> [!NOTE]
383383
> You may wish to create a `resources/views/emails` directory to house all of your email templates; however, you are free to place them wherever you wish within your `resources/views` directory.
384384
385385
<a name="plain-text-emails"></a>
@@ -637,7 +637,7 @@ Embedding inline images into your emails is typically cumbersome; however, Larav
637637
</body>
638638
```
639639

640-
> [!WARNING]
640+
> [!WARNING]
641641
> The `$message` variable is not available in plain-text message templates since plain-text messages do not utilize inline attachments.
642642
643643
<a name="embedding-raw-data-attachments"></a>
@@ -851,7 +851,7 @@ Thanks,<br>
851851
</x-mail::message>
852852
```
853853

854-
> [!NOTE]
854+
> [!NOTE]
855855
> Do not use excess indentation when writing Markdown emails. Per Markdown standards, Markdown parsers will render indented content as code blocks.
856856
857857
<a name="button-component"></a>
@@ -1073,7 +1073,7 @@ class OrderShipped extends Mailable implements ShouldQueue
10731073
}
10741074
```
10751075

1076-
> [!NOTE]
1076+
> [!NOTE]
10771077
> To learn more about working around these issues, please review the documentation regarding [queued jobs and database transactions](/docs/{{version}}/queues#jobs-and-database-transactions).
10781078
10791079
<a name="rendering-mailables"></a>

middleware.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ As you can see, if the given `token` does not match our secret token, the middle
6060

6161
It's best to envision middleware as a series of "layers" HTTP requests must pass through before they hit your application. Each layer can examine the request and even reject it entirely.
6262

63-
> [!NOTE]
63+
> [!NOTE]
6464
> All middleware are resolved via the [service container](/docs/{{version}}/container), so you may type-hint any dependencies you need within a middleware's constructor.
6565
6666
<a name="middleware-and-responses"></a>
@@ -325,7 +325,7 @@ If you would like to manually manage all of the middleware within Laravel's defa
325325
})
326326
```
327327

328-
> [!NOTE]
328+
> [!NOTE]
329329
> By default, the `web` and `api` middleware groups are automatically applied to your application's corresponding `routes/web.php` and `routes/api.php` files by the `bootstrap/app.php` file.
330330
331331
<a name="middleware-aliases"></a>

migrations.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Laravel will use the name of the migration to attempt to guess the name of the t
4444

4545
If you would like to specify a custom path for the generated migration, you may use the `--path` option when executing the `make:migration` command. The given path should be relative to your application's base path.
4646

47-
> [!NOTE]
47+
> [!NOTE]
4848
> Migration stubs may be customized using [stub publishing](/docs/{{version}}/artisan#stub-customization).
4949
5050
<a name="squashing-migrations"></a>
@@ -70,7 +70,7 @@ php artisan schema:dump --database=testing --prune
7070

7171
You should commit your database schema file to source control so that other new developers on your team may quickly create your application's initial database structure.
7272

73-
> [!WARNING]
73+
> [!WARNING]
7474
> Migration squashing is only available for the MariaDB, MySQL, PostgreSQL, and SQLite databases and utilizes the database's command-line client.
7575
7676
<a name="migration-structure"></a>
@@ -165,7 +165,7 @@ When the `isolated` option is provided, Laravel will acquire an atomic lock usin
165165
php artisan migrate --isolated
166166
```
167167

168-
> [!WARNING]
168+
> [!WARNING]
169169
> To utilize this feature, your application must be using the `memcached`, `redis`, `dynamodb`, `database`, `file`, or `array` cache driver as your application's default cache driver. In addition, all servers must be communicating with the same central cache server.
170170
171171
<a name="forcing-migrations-to-run-in-production"></a>
@@ -245,7 +245,7 @@ By default, the `migrate:fresh` command only drops tables from the default datab
245245
php artisan migrate:fresh --database=admin
246246
```
247247

248-
> [!WARNING]
248+
> [!WARNING]
249249
> The `migrate:fresh` command will drop all database tables regardless of their prefix. This command should be used with caution when developing on a database that is shared with other applications.
250250
251251
<a name="tables"></a>
@@ -722,7 +722,7 @@ The `geography` method creates a `GEOGRAPHY` equivalent column with the given sp
722722
$table->geography('coordinates', subtype: 'point', srid: 4326);
723723
```
724724

725-
> [!NOTE]
725+
> [!NOTE]
726726
> Support for spatial types depends on your database driver. Please refer to your database's documentation. If your application is utilizing a PostgreSQL database, you must install the [PostGIS](https://postgis.net) extension before the `geography` method may be used.
727727
728728
<a name="column-method-geometry"></a>
@@ -734,7 +734,7 @@ The `geometry` method creates a `GEOMETRY` equivalent column with the given spat
734734
$table->geometry('positions', subtype: 'point', srid: 0);
735735
```
736736

737-
> [!NOTE]
737+
> [!NOTE]
738738
> Support for spatial types depends on your database driver. Please refer to your database's documentation. If your application is utilizing a PostgreSQL database, you must install the [PostGIS](https://postgis.net) extension before the `geometry` method may be used.
739739
740740
<a name="column-method-id"></a>
@@ -1229,7 +1229,7 @@ return new class extends Migration
12291229
};
12301230
```
12311231

1232-
> [!WARNING]
1232+
> [!WARNING]
12331233
> Support for default expressions depends on your database driver, database version, and the field type. Please refer to your database's documentation.
12341234
12351235
<a name="column-order"></a>
@@ -1508,7 +1508,7 @@ Schema::withoutForeignKeyConstraints(function () {
15081508
});
15091509
```
15101510

1511-
> [!WARNING]
1511+
> [!WARNING]
15121512
> SQLite disables foreign key constraints by default. When using SQLite, make sure to [enable foreign key support](/docs/{{version}}/database#configuration) in your database configuration before attempting to create them in your migrations.
15131513
15141514
<a name="events"></a>

mix.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ mix.js('resources/js/app.js', 'public/js')
1616

1717
If you've ever been confused and overwhelmed about getting started with webpack and asset compilation, you will love Laravel Mix. However, you are not required to use it while developing your application; you are free to use any asset pipeline tool you wish, or even none at all.
1818

19-
> [!NOTE]
19+
> [!NOTE]
2020
> Vite has replaced Laravel Mix in new Laravel installations. For Mix documentation, please visit the [official Laravel Mix](https://laravel-mix.com/) website. If you would like to switch to Vite, please see our [Vite migration guide](https://github.com/laravel/vite-plugin/blob/main/UPGRADE.md#migrating-from-laravel-mix-to-vite).

mocking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ class UserControllerTest extends TestCase
154154
}
155155
```
156156

157-
> [!WARNING]
157+
> [!WARNING]
158158
> You should not mock the `Request` facade. Instead, pass the input you desire into the [HTTP testing methods](/docs/{{version}}/http-tests) such as `get` and `post` when running your test. Likewise, instead of mocking the `Config` facade, call the `Config::set` method in your tests.
159159
160160
<a name="facade-spies"></a>

mongodb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Finally, use Composer to install the Laravel MongoDB package:
6666
composer require mongodb/laravel-mongodb
6767
```
6868

69-
> [!NOTE]
69+
> [!NOTE]
7070
> This installation of the package will fail if the `mongodb` PHP extension is not installed. The PHP configuration can differ between the CLI and the web server, so ensure the extension is enabled in both configurations.
7171
7272
<a name="configuration"></a>

notifications.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ Thanks,<br>
831831
</x-mail::message>
832832
```
833833

834-
> [!NOTE]
834+
> [!NOTE]
835835
> Do not use excess indentation when writing Markdown emails. Per Markdown standards, Markdown parsers will render indented content as code blocks.
836836
837837
<a name="button-component"></a>

octane.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ php artisan octane:install
4747
<a name="server-prerequisites"></a>
4848
## Server Prerequisites
4949

50-
> [!WARNING]
50+
> [!WARNING]
5151
> Laravel Octane requires [PHP 8.1+](https://php.net/releases/).
5252
5353
<a name="frankenphp"></a>
@@ -204,7 +204,7 @@ Using Laravel Octane with Open Swoole grants the same functionality provided by
204204
<a name="swoole-via-laravel-sail"></a>
205205
#### Swoole via Laravel Sail
206206

207-
> [!WARNING]
207+
> [!WARNING]
208208
> Before serving an Octane application via Sail, ensure you have the latest version of Laravel Sail and execute `./vendor/bin/sail build --no-cache` within your application's root directory.
209209

210210
Alternatively, you may develop your Swoole based Octane application using [Laravel Sail](/docs/{{version}}/sail), the official Docker based development environment for Laravel. Laravel Sail includes the Swoole extension by default. However, you will still need to adjust the `docker-compose.yml` file used by Sail.
@@ -261,7 +261,7 @@ By default, applications running via Octane generate links prefixed with `http:/
261261
<a name="serving-your-application-via-nginx"></a>
262262
### Serving Your Application via Nginx
263263

264-
> [!NOTE]
264+
> [!NOTE]
265265
> If you aren't quite ready to manage your own server configuration or aren't comfortable configuring all of the various services needed to run a robust Laravel Octane application, check out [Laravel Cloud](https://cloud.laravel.com), which offers fully-managed Laravel Octane support.
266266

267267
In production environments, you should serve your Octane application behind a traditional web server such as Nginx or Apache. Doing so will allow the web server to serve your static assets such as images and stylesheets, as well as manage your SSL certificate termination.
@@ -482,7 +482,7 @@ $service->method($request->input('name'));
482482

483483
The global `request` helper will always return the request the application is currently handling and is therefore safe to use within your application.
484484

485-
> [!WARNING]
485+
> [!WARNING]
486486
> It is acceptable to type-hint the `Illuminate\Http\Request` instance on your controller methods and route closures.
487487

488488
<a name="configuration-repository-injection"></a>
@@ -553,7 +553,7 @@ While building your application, you should take special care to avoid creating
553553
<a name="concurrent-tasks"></a>
554554
## Concurrent Tasks
555555

556-
> [!WARNING]
556+
> [!WARNING]
557557
> This feature requires [Swoole](#swoole).
558558

559559
When using Swoole, you may execute operations concurrently via light-weight background tasks. You may accomplish this using Octane's `concurrently` method. You may combine this method with PHP array destructuring to retrieve the results of each operation:
@@ -580,7 +580,7 @@ When invoking the `concurrently` method, you should not provide more than 1024 t
580580
<a name="ticks-and-intervals"></a>
581581
## Ticks and Intervals
582582

583-
> [!WARNING]
583+
> [!WARNING]
584584
> This feature requires [Swoole](#swoole).
585585

586586
When using Swoole, you may register "tick" operations that will be executed every specified number of seconds. You may register "tick" callbacks via the `tick` method. The first argument provided to the `tick` method should be a string that represents the name of the ticker. The second argument should be a callable that will be invoked at the specified interval.
@@ -603,7 +603,7 @@ Octane::tick('simple-ticker', fn () => ray('Ticking...'))
603603
<a name="the-octane-cache"></a>
604604
## The Octane Cache
605605

606-
> [!WARNING]
606+
> [!WARNING]
607607
> This feature requires [Swoole](#swoole).
608608

609609
When using Swoole, you may leverage the Octane cache driver, which provides read and write speeds of up to 2 million operations per second. Therefore, this cache driver is an excellent choice for applications that need extreme read / write speeds from their caching layer.
@@ -614,7 +614,7 @@ This cache driver is powered by [Swoole tables](https://www.swoole.co.uk/docs/mo
614614
Cache::store('octane')->put('framework', 'Laravel', 30);
615615
```
616616

617-
> [!NOTE]
617+
> [!NOTE]
618618
> The maximum number of entries allowed in the Octane cache may be defined in your application's `octane` configuration file.
619619

620620
<a name="cache-intervals"></a>
@@ -633,7 +633,7 @@ Cache::store('octane')->interval('random', function () {
633633
<a name="tables"></a>
634634
## Tables
635635

636-
> [!WARNING]
636+
> [!WARNING]
637637
> This feature requires [Swoole](#swoole).
638638

639639
When using Swoole, you may define and interact with your own arbitrary [Swoole tables](https://www.swoole.co.uk/docs/modules/swoole-table). Swoole tables provide extreme performance throughput and the data in these tables can be accessed by all workers on the server. However, the data within them will be lost when the server is restarted.
@@ -662,5 +662,5 @@ Octane::table('example')->set('uuid', [
662662
return Octane::table('example')->get('uuid');
663663
```
664664

665-
> [!WARNING]
665+
> [!WARNING]
666666
> The column types supported by Swoole tables are: `string`, `int`, and `float`.

packages.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Now, when users of your package execute Laravel's `vendor:publish` command, your
111111
$value = config('courier.option');
112112
```
113113

114-
> [!WARNING]
114+
> [!WARNING]
115115
> You should not define closures in your configuration files. They cannot be serialized correctly when users execute the `config:cache` Artisan command.
116116
117117
<a name="default-package-configuration"></a>
@@ -133,7 +133,7 @@ public function register(): void
133133
}
134134
```
135135

136-
> [!WARNING]
136+
> [!WARNING]
137137
> This method only merges the first level of the configuration array. If your users partially define a multi-dimensional configuration array, the missing options will not be merged.
138138
139139
<a name="routes"></a>

pagination.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ $users = DB::table('users')->orderBy('id')->cursorPaginate(15);
137137

138138
Once you have retrieved a cursor paginator instance, you may [display the pagination results](#displaying-pagination-results) as you typically would when using the `paginate` and `simplePaginate` methods. For more information on the instance methods offered by the cursor paginator, please consult the [cursor paginator instance method documentation](#cursor-paginator-instance-methods).
139139

140-
> [!WARNING]
140+
> [!WARNING]
141141
> Your query must contain an "order by" clause in order to take advantage of cursor pagination. In addition, the columns that the query are ordered by must belong to the table you are paginating.
142142
143143
<a name="cursor-vs-offset-pagination"></a>
@@ -174,7 +174,7 @@ The `Paginator` and `CursorPaginator` classes do not need to know the total numb
174174

175175
In other words, the `Paginator` corresponds to the `simplePaginate` method on the query builder, the `CursorPaginator` corresponds to the `cursorPaginate` method, and the `LengthAwarePaginator` corresponds to the `paginate` method.
176176

177-
> [!WARNING]
177+
> [!WARNING]
178178
> When manually creating a paginator instance, you should manually "slice" the array of results you pass to the paginator. If you're unsure how to do this, check out the [array_slice](https://secure.php.net/manual/en/function.array-slice.php) PHP function.
179179
180180
<a name="customizing-pagination-urls"></a>

0 commit comments

Comments
 (0)