Skip to content

Commit 5b4730d

Browse files
AlessioGrAlessioGr
authored
docs: fix incorrect escaping of * (#10274)
1 parent 6dac4c5 commit 5b4730d

36 files changed

+112
-112
lines changed

‎docs/admin/views.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,14 @@ For more granular control, pass a configuration object instead. Payload exposes
8989

9090
| Property | Description |
9191
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
92-
| **`Component`** \* | Pass in the component path that should be rendered when a user navigates to this route. |
93-
| **`path`** \* | Any valid URL path or array of paths that [`path-to-regexp`](https://www.npmjs.com/package/path-to-regex) understands. |
92+
| **`Component`** * | Pass in the component path that should be rendered when a user navigates to this route. |
93+
| **`path`** * | Any valid URL path or array of paths that [`path-to-regexp`](https://www.npmjs.com/package/path-to-regex) understands. |
9494
| **`exact`** | Boolean. When true, will only match if the path matches the `usePathname()` exactly. |
9595
| **`strict`** | When true, a path that has a trailing slash will only match a `location.pathname` with a trailing slash. This has no effect when there are additional URL segments in the pathname. |
9696
| **`sensitive`** | When true, will match if the path is case sensitive.|
9797
| **`meta`** | Page metadata overrides to apply to this view within the Admin Panel. [More details](./metadata). |
9898

99-
_\* An asterisk denotes that a property is required._
99+
_* An asterisk denotes that a property is required._
100100

101101
### Adding New Views
102102

‎docs/authentication/custom-strategies.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ A strategy is made up of the following:
1919

2020
| Parameter | Description |
2121
| --------------------------- | ------------------------------------------------------------------------- |
22-
| **`name`** \* | The name of your strategy |
23-
| **`authenticate`** \* | A function that takes in the parameters below and returns a user or null. |
22+
| **`name`** * | The name of your strategy |
23+
| **`authenticate`** * | A function that takes in the parameters below and returns a user or null. |
2424

2525
The `authenticate` function is passed the following arguments:
2626

2727
| Argument | Description |
2828
| ------------------- | ------------------------------------------------------------------------------------------------- |
29-
| **`headers`** \* | The headers on the incoming request. Useful for retrieving identifiable information on a request. |
30-
| **`payload`** \* | The Payload class. Useful for authenticating the identifiable information against Payload. |
29+
| **`headers`** * | The headers on the incoming request. Useful for retrieving identifiable information on a request. |
30+
| **`payload`** * | The Payload class. Useful for authenticating the identifiable information against Payload. |
3131
| **`isGraphQL`** | Whether or not the request was made from a GraphQL endpoint. Default is `false`. |
3232

3333

‎docs/configuration/collections.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,19 +67,19 @@ The following options are available:
6767
| **`defaultSort`** | Pass a top-level field to sort by default in the Collection List View. Prefix the name of the field with a minus symbol ("-") to sort in descending order. Multiple fields can be specified by using a string array. |
6868
| **`dbName`** | Custom table or Collection name depending on the Database Adapter. Auto-generated from slug if not defined. |
6969
| **`endpoints`** | Add custom routes to the REST API. Set to `false` to disable routes. [More details](../rest-api/overview#custom-endpoints). |
70-
| **`fields`** \* | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview). |
70+
| **`fields`** * | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview). |
7171
| **`graphQL`** | Manage GraphQL-related properties for this collection. [More](#graphql) |
7272
| **`hooks`** | Entry point for Hooks. [More details](../hooks/overview#collection-hooks). |
7373
| **`labels`** | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined. |
7474
| **`lockDocuments`** | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents). |
75-
| **`slug`** \* | Unique, URL-friendly string that will act as an identifier for this Collection. |
75+
| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Collection. |
7676
| **`timestamps`** | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps. |
7777
| **`typescript`** | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined. |
7878
| **`upload`** | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](../upload/overview) documentation. |
7979
| **`versions`** | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#collection-config). |
8080
| **`defaultPopulate`** | Specify which fields to select when this Collection is populated from another document. [More Details](../queries/select#defaultpopulate-collection-config-property). |
8181

82-
_\* An asterisk denotes that a property is required._
82+
_* An asterisk denotes that a property is required._
8383

8484
### Fields
8585

‎docs/configuration/globals.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,16 +73,16 @@ The following options are available:
7373
| **`dbName`** | Custom table or collection name for this Global depending on the Database Adapter. Auto-generated from slug if not defined. |
7474
| **`description`** | Text or React component to display below the Global header to give editors more information. |
7575
| **`endpoints`** | Add custom routes to the REST API. [More details](../rest-api/overview#custom-endpoints). |
76-
| **`fields`** \* | Array of field types that will determine the structure and functionality of the data stored within this Global. [More details](../fields/overview). |
76+
| **`fields`** * | Array of field types that will determine the structure and functionality of the data stored within this Global. [More details](../fields/overview). |
7777
| **`graphQL`** | Manage GraphQL-related properties related to this global. [More details](#graphql) |
7878
| **`hooks`** | Entry point for Hooks. [More details](../hooks/overview#global-hooks). |
7979
| **`label`** | Text for the name in the Admin Panel or an object with keys for each language. Auto-generated from slug if not defined. |
8080
| **`lockDocuments`** | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents). |
81-
| **`slug`** \* | Unique, URL-friendly string that will act as an identifier for this Global. |
81+
| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Global. |
8282
| **`typescript`** | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined. |
8383
| **`versions`** | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#globals-config). |
8484

85-
_\* An asterisk denotes that a property is required._
85+
_* An asterisk denotes that a property is required._
8686

8787
### Fields
8888

‎docs/configuration/localization.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,12 @@ The locale codes do not need to be in any specific format. It's up to you to def
9393

9494
| Option | Description |
9595
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
96-
| **`code`** \* | Unique code to identify the language throughout the APIs for `locale` and `fallbackLocale` |
96+
| **`code`** * | Unique code to identify the language throughout the APIs for `locale` and `fallbackLocale` |
9797
| **`label`** | A string to use for the selector when choosing a language, or an object keyed on the i18n keys for different languages in use. |
9898
| **`rtl`** | A boolean that when true will make the admin UI display in Right-To-Left. |
9999
| **`fallbackLocale`** | The code for this language to fallback to when properties of a document are not present. |
100100

101-
_\* An asterisk denotes that a property is required._
101+
_* An asterisk denotes that a property is required._
102102

103103
## Field Localization
104104

‎docs/configuration/overview.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following options are available:
6868
| **`admin`** | The configuration options for the Admin Panel, including Custom Components, Live Preview, etc. [More details](../admin/overview#admin-options). |
6969
| **`bin`** | Register custom bin scripts for Payload to execute. |
7070
| **`editor`** | The Rich Text Editor which will be used by `richText` fields. [More details](../rich-text/overview). |
71-
| **`db`** \* | The Database Adapter which will be used by Payload. [More details](../database/overview). |
71+
| **`db`** * | The Database Adapter which will be used by Payload. [More details](../database/overview). |
7272
| **`serverURL`** | A string used to define the absolute URL of your app. This includes the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port. |
7373
| **`collections`** | An array of Collections for Payload to manage. [More details](./collections). |
7474
| **`compatibility`** | Compatibility flags for earlier versions of Payload. [More details](#compatibility-flags). |
@@ -95,11 +95,11 @@ The following options are available:
9595
| **`endpoints`** | An array of Custom Endpoints added to the Payload router. [More details](../rest-api/overview#custom-endpoints). |
9696
| **`custom`** | Extension point for adding custom data (e.g. for plugins). |
9797
| **`i18n`** | Internationalization configuration. Pass all i18n languages you'd like the admin UI to support. Defaults to English-only. [More details](./i18n). |
98-
| **`secret`** \* | A secure, unguessable string that Payload will use for any encryption workflows - for example, password salt / hashing. |
98+
| **`secret`** * | A secure, unguessable string that Payload will use for any encryption workflows - for example, password salt / hashing. |
9999
| **`sharp`** | If you would like Payload to offer cropping, focal point selection, and automatic media resizing, install and pass the Sharp module to the config here. |
100100
| **`typescript`** | Configure TypeScript settings here. [More details](#typescript). |
101101

102-
_\* An asterisk denotes that a property is required._
102+
_* An asterisk denotes that a property is required._
103103

104104
<Banner type="warning">
105105
**Note:**
@@ -139,7 +139,7 @@ For Payload command-line scripts, we need to be able to locate your Payload Conf
139139
1. The `compilerOptions` in your `tsconfig`*
140140
1. The `dist` directory*
141141

142-
_\* Config location detection is different between development and production environments. See below for more details._
142+
_* Config location detection is different between development and production environments. See below for more details._
143143

144144
<Banner type="warning">
145145
**Important:**

‎docs/database/postgres.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export default buildConfig({
5959

6060
| Option | Description |
6161
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
62-
| `pool` \* | [Pool connection options](https://orm.drizzle.team/docs/quick-postgresql/node-postgres) that will be passed to Drizzle and `node-postgres` or to `@vercel/postgres` |
62+
| `pool` * | [Pool connection options](https://orm.drizzle.team/docs/quick-postgresql/node-postgres) that will be passed to Drizzle and `node-postgres` or to `@vercel/postgres` |
6363
| `push` | Disable Drizzle's [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push) in development mode. By default, `push` is enabled for development mode only. |
6464
| `migrationDir` | Customize the directory that migrations are stored. |
6565
| `schemaName` (experimental) | A string for the postgres schema to use, defaults to 'public'. |

‎docs/database/sqlite.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export default buildConfig({
3636

3737
| Option | Description |
3838
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
39-
| `client` \* | [Client connection options](https://orm.drizzle.team/docs/get-started-sqlite#turso) that will be passed to `createClient` from `@libsql/client`. |
39+
| `client` * | [Client connection options](https://orm.drizzle.team/docs/get-started-sqlite#turso) that will be passed to `createClient` from `@libsql/client`. |
4040
| `push` | Disable Drizzle's [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push) in development mode. By default, `push` is enabled for development mode only. |
4141
| `migrationDir` | Customize the directory that migrations are stored. |
4242
| `logger` | The instance of the logger to be passed to drizzle. By default Payload's will be used. |
@@ -172,7 +172,7 @@ sqliteAdapter({
172172
})
173173
```
174174

175-
Make sure Payload doesn't overlap table names with its collections. For example, if you already have a collection with slug "users", you should either change the slug or `dbName` to change the table name for this collection.
175+
Make sure Payload doesn't overlap table names with its collections. For example, if you already have a collection with slug "users", you should either change the slug or `dbName` to change the table name for this collection.
176176

177177

178178
### afterSchemaInit

0 commit comments

Comments
 (0)