summaryrefslogtreecommitdiff
path: root/examples/docs/src/consts.ts
diff options
context:
space:
mode:
authorGravatar Ben Holmes <hey@bholmes.dev> 2023-01-18 08:43:58 -0500
committerGravatar GitHub <noreply@github.com> 2023-01-18 08:43:58 -0500
commit7d72aeeae8c867af2ae6c018611e39c184f50619 (patch)
tree93015c571dc820db3e37e8eba93455014a048d7e /examples/docs/src/consts.ts
parent006405d33c2b8eb1307cb84161659428e43efa51 (diff)
downloadastro-7d72aeeae8c867af2ae6c018611e39c184f50619.tar.gz
astro-7d72aeeae8c867af2ae6c018611e39c184f50619.tar.zst
astro-7d72aeeae8c867af2ae6c018611e39c184f50619.zip
Migrate blog and docs starters to content collections (#5858)
* docs: update README for `content/` * chore: update env * feat: update blog to use content collections * chore: remove with-content starter * fix: single quotes -> double * feat: update docs starter to content collections * refactor: config -> consts * chore: import type * edit: Astro will -> Use Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * chore: remove unused null check * nit: spacing * nit: `as Props` 1 Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com> * nit: `as Props` 2 Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com> * chore: consistent CONSTS usage * chore: `type` imports at top * chore: consistent quote usage on YAML * chore: remove `as Props` from docs Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
Diffstat (limited to 'examples/docs/src/consts.ts')
-rw-r--r--examples/docs/src/consts.ts46
1 files changed, 46 insertions, 0 deletions
diff --git a/examples/docs/src/consts.ts b/examples/docs/src/consts.ts
new file mode 100644
index 000000000..6486f0325
--- /dev/null
+++ b/examples/docs/src/consts.ts
@@ -0,0 +1,46 @@
+export const SITE = {
+ title: 'Documentation',
+ description: 'Your website description.',
+ defaultLanguage: 'en-us',
+} as const;
+
+export const OPEN_GRAPH = {
+ image: {
+ src: 'https://github.com/withastro/astro/blob/main/assets/social/banner-minimal.png?raw=true',
+ alt:
+ 'astro logo on a starry expanse of space,' +
+ ' with a purple saturn-like planet floating in the right foreground',
+ },
+ twitter: 'astrodotbuild',
+};
+
+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' }],
+ },
+};