summaryrefslogtreecommitdiff
path: root/docs/src/config.ts
blob: 98d23fc42fb753a643a7d2ce2d49dc7cd8637d06 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
export const sidebar = [
  {
    text: 'Setup',
    link: '',
    children: [
      { text: 'Getting Started', link: 'getting-started' },
      { text: 'Installation', link: 'installation' },
      { text: 'Quickstart', link: 'quick-start' },
      { text: 'Examples', link: 'examples' },
      { text: 'Astro vs. X', link: 'comparing-astro-vs-other-tools' },
    ],
  },
  {
    text: 'Basics',
    link: 'core-concepts',
    children: [
      { text: 'Project Structure', link: 'core-concepts/project-structure' },
      { text: 'Components', link: 'core-concepts/astro-components' },
      { text: 'Pages', link: 'core-concepts/astro-pages' },
      { text: 'Layouts', link: 'core-concepts/layouts' },
      { text: 'Collections', link: 'core-concepts/collections' },
      { text: 'Partial Hydration', link: 'core-concepts/component-hydration' },
    ],
  },
  {
    text: 'Guides',
    link: 'guides',
    children: [
      { text: 'Styling & CSS', link: 'guides/styling' },
      { text: 'Data Fetching', link: 'guides/data-fetching' },
      { text: 'Markdown', link: 'guides/markdown-content' },
      { text: 'Supported Imports', link: 'guides/imports' },
      // To be written when https://github.com/snowpackjs/astro/issues/501 is completed
      // { text: 'Pagination', link: 'guides/pagination' },
      { text: 'Deploy a Website', link: 'guides/deploy' },
      { text: 'Publish a Component', link: 'guides/publish-to-npm' },
    ],
  },
  {
    text: 'Reference',
    link: 'reference',
    children: [
      { text: 'Built-In Components', link: 'reference/builtin-components' },
      { text: 'API Reference', link: 'reference/api-reference' },
      { text: 'CLI Reference', link: 'reference/cli-reference' },
      {
        text: 'Configuration Reference',
        link: 'reference/configuration-reference',
      },
      { text: 'Renderer Reference', link: 'reference/renderer-reference' },
    ],
  },
  // To add once rest of the site is complete
  // see https://github.com/snowpackjs/astro-docs/issues/9
  // {
  //   text: 'Integrations',
  //   link: 'integrations',
  //   children: [
  //     { text: 'Deploy Astro', link: 'integrations/deploy-astro' },
  //     { text: 'Data Sources / CMS', link: 'integrations/data-sources-cms' },
  //     { text: 'State Management', link: 'integrations/state-management' },
  //     {
  //       text: 'Styles & CSS Libraries',
  //       link: 'integrations/styles-and-css-libraries',
  //     },
  //     { text: 'Developer Tools', link: 'integrations/developer-tools' },
  //   ],
  // },
];

export const site = {
  title: 'Astro Documentation',
  description: 'Build faster websites with less client-side Javascript.',
  ogLocale: 'en_US',
  image: {
    src: '/default-og-image.png?v=1',
    alt:
      'astro logo on a starry expanse of space,' +
      ' with a purple saturn-like planet floating in the right foreground',
  },
  twitter: {
    site: 'astrodotbuild',
    creator: 'astrodotbuild',
  },
};