Skip to content

Commit c23409f

Browse files
committed
docs: make file paths bold
1 parent 6d7567e commit c23409f

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

docs/quickstart.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Learning any new authentication system can be difficult, especially as they get more flexible and sophisticated. This guide is intended to provide short examples for common actions you'll take when working with Shield. It is not intended to be the exhaustive documentation for each section. That's better handled through the area-specific doc files.
44

5-
> **Note** The examples assume that you have run the setup script and that you have copies of the `Auth` and `AuthGroups` config files in your application's `app/Config` folder.
5+
> **Note** The examples assume that you have run the setup script and that you have copies of the `Auth` and `AuthGroups` config files in your application's **app/Config** folder.
66
77
- [Quick Start Guide](#quick-start-guide)
88
- [Authentication Flow](#authentication-flow)
@@ -37,10 +37,10 @@ Learning any new authentication system can be difficult, especially as they get
3737

3838
#### Configure Redirect URLs
3939

40-
If you need everyone to redirect to a single URL after login/logout/register actions, you can modify the `Config\Auth::$redirects` array in `app/Config/Auth.php` to specify the url to redirect to.
40+
If you need everyone to redirect to a single URL after login/logout/register actions, you can modify the `Config\Auth::$redirects` array in **app/Config/Auth.php**`** to specify the url to redirect to.
4141

4242
By default, a successful login or register attempt will all redirect to `/`, while a logout action
43-
will redirect to a [named route](https://codeigniter.com/user_guide/incoming/routing.html#using-named-routes "See routing docs") `login` or a *URI path* `/login`. You can change the default URLs used within the `app/Config/Auth.php` config file:
43+
will redirect to a [named route](https://codeigniter.com/user_guide/incoming/routing.html#using-named-routes "See routing docs") `login` or a *URI path* `/login`. You can change the default URLs used within the **`**app/Config/Auth.php** config file:
4444

4545
```php
4646
public array $redirects = [
@@ -75,7 +75,7 @@ public int $unusedTokenLifetime = YEAR;
7575

7676
#### Enable Account Activation via Email
7777

78-
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
78+
> **Note** You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
7979
8080
By default, once a user registers they have an active account that can be used. You can enable Shield's built-in, email-based activation flow within the `Auth` config file.
8181

@@ -88,7 +88,7 @@ public array $actions = [
8888

8989
#### Enable Two-Factor Authentication
9090

91-
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
91+
> **Note** You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
9292
9393
Turned off by default, Shield's Email-based 2FA can be enabled by specifying the class to use in the `Auth` config file.
9494

@@ -101,7 +101,7 @@ public array $actions = [
101101

102102
### Responding to Magic Link Logins
103103

104-
> **Note** You need to configure `app/Config/Email.php` to allow Shield to send emails. See [Installation](install.md#initial-setup).
104+
> **Note** You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
105105
106106
Magic Link logins allow a user that has forgotten their password to have an email sent with a unique, one-time login link. Once they've logged in you can decide how to respond. In some cases, you might want to redirect them to a special page where they must choose a new password. In other cases, you might simply want to display a one-time message prompting them to go to their account page and choose a new password.
107107

@@ -138,7 +138,7 @@ Events::on('magicLogin', static function () {
138138

139139
#### Change Available Groups
140140

141-
The available groups are defined in the `app/Config/AuthGroups.php` config file, under the `$groups` property. Add new entries to the array, or remove existing ones to make them available throughout your application.
141+
The available groups are defined in the **app/Config/AuthGroups.php** config file, under the `$groups` property. Add new entries to the array, or remove existing ones to make them available throughout your application.
142142

143143
```php
144144
public array $groups = [

0 commit comments

Comments
 (0)