Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Give more room for customizations #1456

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Give more room for customizations #1456

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift click to select a range
d143b24
Give more room for customizations
kamilkisiela Apr 11, 2024
411f3db
Give more room for customizations
kamilkisiela Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Give more room for customizations
  • Loading branch information
@kamilkisiela @n1ru4l
kamilkisiela authored and n1ru4l committed May 15, 2024
commit d143b24fcbc295c96635d3f9805a3161b8ae98fe
73 changes: 52 additions & 21 deletions packages/components/src/define-config.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 5,25 @@ import { addGuildCompanyMenu } from './components/company-menu';
import { GuildUnifiedLogo } from './components/guild-navbar';
import { ThemeSwitcherButton } from './components/theme-switcher';

export function defineConfig({
websiteName,
description,
logo,
...config
}: DocsThemeConfig & {
websiteName: string;
description: string;
}): DocsThemeConfig {
export function defineConfig(
config: DocsThemeConfig &
(
| {
websiteName: string;
description: string;
}
| {
titleSuffix?: string;
title: string;
description: string;
productLogo: {
name: string;
tagline: string;
};
ogImage: (props: { title: string; description?: string }) => string;
}
),
): DocsThemeConfig {
if (!config.docsRepositoryBase) {
throw new Error('Missing required "docsRepositoryBase" property');
}
Expand Down Expand Up @@ -46,12 56,14 @@ export function defineConfig({
const { asPath } = useRouter();

const {
description = `${websiteName} Documentation`,
description = 'websiteName' in config
? `${config.websiteName} Documentation`
: `Documentation${config.titleSuffix}`,
type = 'website',
canonical = siteUrl &&
`${siteUrl}${
// we disallow trailing slashes
// TODO: dont do this if `trailingSlashes: true`
// TODO: don't do this if `trailingSlashes: true`
asPath === '/'
? // homepage
''
Expand All @@ -61,12 73,20 @@ export function defineConfig({
: // other pages
asPath
}`,
image = `https://og-image.the-guild.dev/?product=${websiteName}&title=${encodeURI(
pageTitle,
)}`,
image = 'ogImage' in config
? config.ogImage({
title: pageTitle,
description: frontMatter.description ?? description,
})
: `https://og-image.the-guild.dev/?product=${config.websiteName}&title=${encodeURI(
pageTitle,
)}`,
} = frontMatter;

const title = `${pageTitle} (${websiteName})`;
const title =
'websiteName' in config
? `${pageTitle} (${config.websiteName})`
: `${pageTitle}${config.titleSuffix}`;

return (
<>
Expand All @@ -90,25 110,36 @@ export function defineConfig({
<meta name="twitter:creator" content="@TheGuildDev" />

<meta property="og:type" content={type} />
<meta property="og:site_name" content={websiteName} />
{'websiteName' in config ? (
<meta property="og:site_name" content={config.websiteName} />
) : null}
<meta property="og:image" content={image} />
<meta property="og:image:alt" content={pageTitle} />

<meta content={websiteName} name="apple-mobile-web-app-title" />
<meta content={websiteName} name="application-name" />
{'websiteName' in config ? (
<meta content={config.websiteName} name="apple-mobile-web-app-title" />
) : null}
{'websiteName' in config ? (
<meta content={config.websiteName} name="application-name" />
) : null}
<meta name="robots" content="index,follow" />
</>
);
},
logoLink: false,
logo: (
<GuildUnifiedLogo description={description} title={websiteName}>
{logo}
<GuildUnifiedLogo
description={'productLogo' in config ? config.productLogo.tagline : config.description}
title={'productLogo' in config ? config.productLogo.name : config.websiteName}
>
{config.logo}
</GuildUnifiedLogo>
),
navbar: {
extraContent: <ThemeSwitcherButton />,
...(logo && { component: props => <Navbar items={addGuildCompanyMenu(props.items)} /> }),
...(config.logo && {
component: props => <Navbar items={addGuildCompanyMenu(props.items)} />,
}),
},
...config,
components: {
Expand Down