docs: refactor social links configuration reference #869
Conversation
* main: Add missing changeset from withastro#852 i18n(zh-CN): fix another link to astro main doc (withastro#867) i18n(zh-CN): fix link to astro main doc (withastro#866) [i18nIgnore] i18n(zh-cn): Fix Chinese subtag (withastro#855)
|
👷 Deploy Preview for astro-starlight processing.
|
github-actions
bot
added
📚 docs
| @@ -208,7 +208,7 @@ interface BadgeConfig { | |||
|
|
|||
| ### `locales` | |||
|
|
|||
| **type:** <code>{ \[dir: string\]: [LocaleConfig](#localeconfig) }</code> | |||
| **type:** <code>\{ \[dir: string\]: [LocaleConfig](#localeconfig) \}</code> | |||
There was a problem hiding this comment.
Change required due to the MDX conversion to avoid interpreting this as an expression.
| --- | ||
| import { socialLinks } from '../../../packages/starlight/schemas/social'; | ||
| const socials = [...socialLinks].sort((a, b) => a.localeCompare(b, 'en')); |
There was a problem hiding this comment.
Relying on localeCompare() in the compare function instead of a basic sort() to ensure a case-insensitive sort so that codeberg appears before codePen in the list for example.
There was a problem hiding this comment.
Looks good. Initially, I wondered if we should sort with the current page’s locale instead of always en, but on second thoughts, given this list’s contents, this makes sense 👍
| --- | ||
| import { socialLinks } from '../../../packages/starlight/schemas/social'; | ||
| const socials = [...socialLinks].sort((a, b) => a.localeCompare(b, 'en')); |
There was a problem hiding this comment.
Looks good. Initially, I wondered if we should sort with the current page’s locale instead of always en, but on second thoughts, given this list’s contents, this makes sense 👍
Co-authored-by: Chris Swithinbank <[email protected]>
| const socials = [...socialLinks].sort((a, b) => a.localeCompare(b, 'en')); | ||
| --- | ||
|
|
||
| <code>{`Partial<Record<${socials.map((social) => `'${social}'`).join(' | ')}, string>>`}</code> |
There was a problem hiding this comment.
This component is very creative!
* main: (42 commits) docs: refactor sidebar label translations examples to use tags with regional subtags (withastro#881) Add Nostalgist.js docs to showcase (withastro#900) i18n(id): Fix environmental-impact.md translation (withastro#899) i18n(es): Update `customization.mdx`, `i18n.mdx` & `configuration.md` (withastro#897) i18n(ko): update `configuration.md` (withastro#896) i18n(ko): update `i18n.mdx` (withastro#895) i18n(ko): update `customization.mdx` (withastro#894) [ci] format i18n(id): translate guides/components.mdx and guides/project-structure.mdx (withastro#898) [ci] format [ci] release (withastro#865) Add Patreon social link (withastro#892) [ci] format Add Ukrainian language support (withastro#891) i18n(id): Translate more pages and improve existing translations (withastro#859) [ci] format feat: add Reddit social icon (withastro#854) [ci] format i18n(ru): added translations for components, css-and-tailwind, environmental-impact, project-structure pages (withastro#888) i18n(id): translate `guides/authoring-content.md` (withastro#863) ...
improve wording acima -> em cima
What kind of changes does this PR include?
Description
As discussed on Discord, this pull request refactors the social links section of the Customizing Starlight guide by removing the complete list of social links and replacing it with a link to the configuration reference where the type is now dynamically generated.
This means that PRs adding new social links will no longer require follow-up i18n PRs.
Notes:
guides/customization.mdx.