mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
feb88afb8c
* fix: improve docs example * final touches * chore: prettier * lockfile * ci? * downgrade types node * fresh lockfile * lockfile and npmrc * remove debug log * Merge branch 'main' into docs-template-ts * merging lockfiles suck * update lockfile * satisfy linter
57 lines
1.5 KiB
TypeScript
57 lines
1.5 KiB
TypeScript
export const SITE = {
|
|
title: 'Documentation',
|
|
description: 'Your website description.',
|
|
defaultLanguage: 'en_US',
|
|
};
|
|
|
|
export const OPEN_GRAPH = {
|
|
image: {
|
|
src: 'https://github.com/withastro/astro/blob/main/assets/social/banner.jpg?raw=true',
|
|
alt:
|
|
'astro logo on a starry expanse of space,' +
|
|
' with a purple saturn-like planet floating in the right foreground',
|
|
},
|
|
twitter: 'astrodotbuild',
|
|
};
|
|
|
|
// This is the type of the frontmatter you put in the docs markdown files.
|
|
export type Frontmatter = {
|
|
title: string;
|
|
description: string;
|
|
layout: string;
|
|
image?: { src: string; alt: string };
|
|
dir?: 'ltr' | 'rtl';
|
|
ogLocale?: string;
|
|
lang?: string;
|
|
};
|
|
|
|
export const KNOWN_LANGUAGES = {
|
|
English: 'en',
|
|
} as const;
|
|
export const KNOWN_LANGUAGE_CODES = Object.values(KNOWN_LANGUAGES);
|
|
|
|
export const GITHUB_EDIT_URL = `https://github.com/withastro/astro/tree/main/examples/docs`;
|
|
|
|
export const COMMUNITY_INVITE_URL = `https://astro.build/chat`;
|
|
|
|
// See "Algolia" section of the README for more information.
|
|
export const ALGOLIA = {
|
|
indexName: 'XXXXXXXXXX',
|
|
appId: 'XXXXXXXXXX',
|
|
apiKey: 'XXXXXXXXXX',
|
|
};
|
|
|
|
export type Sidebar = Record<
|
|
typeof KNOWN_LANGUAGE_CODES[number],
|
|
Record<string, { text: string; link: string }[]>
|
|
>;
|
|
export const SIDEBAR: Sidebar = {
|
|
en: {
|
|
'Section Header': [
|
|
{ text: 'Introduction', link: 'en/introduction' },
|
|
{ text: 'Page 2', link: 'en/page-2' },
|
|
{ text: 'Page 3', link: 'en/page-3' },
|
|
],
|
|
'Another Section': [{ text: 'Page 4', link: 'en/page-4' }],
|
|
},
|
|
};
|