docs: fixes misc links (#2971)

This commit is contained in:
Jacob Fletcher
2023-07-05 12:02:56 -04:00
committed by GitHub
parent 03c2b36b84
commit 9b22c4b654
10 changed files with 191 additions and 138 deletions

View File

@@ -11,44 +11,49 @@ Not only does Payload support managing localized content, it also has internatio
While Payload's built-in features come translated, you may want to also translate parts of your project's configuration too. This is possible in places like collections and globals labels and groups, field labels, descriptions and input placeholder text. The admin UI will display all the correct translations you provide based on the user's language.
Here is an example of a simple collection supporting both English and Spanish editors:
```ts
import { CollectionConfig } from 'payload/types';
import { CollectionConfig } from "payload/types";
export const Articles: CollectionConfig = {
slug: 'articles',
slug: "articles",
labels: {
singular: {
en: 'Article', es: 'Artículo',
en: "Article",
es: "Artículo",
},
plural: {
en: 'Articles', es: 'Artículos',
en: "Articles",
es: "Artículos",
},
},
admin: {
group: { en: 'Content', es: 'Contenido' },
group: { en: "Content", es: "Contenido" },
},
fields: [
{
name: 'title',
type: 'text',
name: "title",
type: "text",
label: {
en: 'Title', es: 'Título',
en: "Title",
es: "Título",
},
admin: {
placeholder: { en: 'Enter title', es: 'Introduce el título' }
}
placeholder: { en: "Enter title", es: "Introduce el título" },
},
},
{
name: 'type',
type: 'radio',
options: [{
value: 'news',
label: { en: 'News', es: 'Noticias' },
}, // etc...
name: "type",
type: "radio",
options: [
{
value: "news",
label: { en: "News", es: "Noticias" },
}, // etc...
],
},
],
}
};
```
### Admin UI
@@ -57,8 +62,10 @@ The Payload admin panel reads the language settings of a user's browser and disp
After a user logs in, they can change their language selection in the `/account` view.
<Banner>
<strong>Note:</strong><br/>
If there is a language that Payload does not yet support, we accept code <a href="https://github.com/payloadcms/payload/blob/master/contributing.md">contributions</a>.
<strong>Note:</strong>
<br />
If there is a language that Payload does not yet support, we accept code
[contributions](https://github.com/payloadcms/payload/blob/master/contributing.md).
</Banner>
### Node Express
@@ -76,21 +83,22 @@ In your Payload config, you can add translations and customize the settings in `
**Example Payload config extending i18n:**
```ts
import { buildConfig } from 'payload/config'
import { buildConfig } from "payload/config";
export default buildConfig({
//...
i18n: {
fallbackLng: 'en', // default
fallbackLng: "en", // default
debug: false, // default
resources: {
en: {
custom: { // namespace can be anything you want
key1: 'Translation with {{variable}}', // translation
custom: {
// namespace can be anything you want
key1: "Translation with {{variable}}", // translation
},
// override existing translation keys
general: {
dashboard: 'Home',
dashboard: "Home",
},
},
},