astro-reactive-form/apps/docs/src/config.ts
Ayo Ayco 47c0b5e90e
docs: clean up (#180)
* docs: clean up

* landing-page: remove image; update deps

* landing-page: remove twitter icon

* style(landing-page): set md maxwidth for copylink
2022-11-07 19:32:29 +01:00

68 lines
2 KiB
TypeScript

export const SITE = {
title: "Astro Reactive Docs",
description:
"Let your data build your UI with native Astro components and architecture.",
defaultLanguage: "en_US",
};
export const OPEN_GRAPH = {
image: {
src: "https://github.com/ayoayco/astro-reactive-library/blob/main/.github/assets/astro-reactive-library-cover.png?raw=true",
alt: "astro logo and astro reactive library text on a starry expanse of space",
},
twitter: "astroreactive",
};
// 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/ayoayco/astro-reactive-library/tree/main/apps/docs`;
export const COMMUNITY_INVITE_URL = `https://github.com/ayoayco/astro-reactive-library/discussions`;
// 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: {
// TODO: create tutorial
// Tutorial: [
// { text: "Getting Started", link: "en/getting-started" },
// { text: "Page 2", link: "en/page-2" },
// { text: "Page 3", link: "en/page-3" },
// ],
// TODO: create overview
Introduction: [
{ text: "Overview", link: "en/introduction" },
// { text: "Philosophy", link: "en/philosophy" },
],
"API Docs": [
{ text: "Form", link: "en/api/form/form-component" },
{ text: "FormGroup", link: "en/api/form/form-group" },
{ text: "FormControl", link: "en/api/form/form-control" },
],
},
};