shepherd/docs-src/astro.config.mjs at eaa0053e1b073ffc99ed6f7cb672a7e9e0a1f0a5 · shipshapecode/shepherd · GitHub

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
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc';
import tailwind from "@astrojs/tailwind";

// https://astro.build/config
export default defineConfig({
  integrations: [
    starlight({
      title: 'Documentation',
      description:
        'Shepherd is a way for guiding users through your app to that moment of "aha!".',
      logo: {
        src: './src/assets/Shepherd-Lamb.svg'
      },
      favicon: '/favicon.ico',
      social: {
        github: 'https://github.com/shipshapecode/shepherd'
      },
      components: {
        // Override the default `Head` component.
        Head: './src/components/HeadWithPosthog.astro'
      },
      plugins: [
        starlightTypeDoc({
          entryPoints: ['./node_modules/shepherd.js/src/*.ts'],
          tsconfig: './node_modules/shepherd.js/tsconfig.json',
          typeDoc: {
            entryPointStrategy: 'expand',
            includeVersion: true
          }
        })
      ],
      sidebar: [
        {
          label: 'Guides',
          items: [
            {
              label: 'Install',
              link: '/guides/install/'
            },
            {
              label: 'Styling',
              link: '/guides/styling/'
            },
            {
              label: 'Usage',
              link: '/guides/usage/'
            },
            {
              label: 'License & Pricing',
              link: '/guides/license/'
            }
          ]
        },
        {
          label: 'Recipes',
          items: [
            {
              label: 'Cookbook',
              link: '/recipes/cookbook/'
            },
            {
              label: 'Analytics',
              link: '/guides/analytics/'
            },
            {
              label: 'React',
              link: '/recipes/react/'
            }
          ]
        },
        // {
        //   label: 'Reference',
        //   autogenerate: {
        //     directory: 'reference'
        //   }
        // },
        typeDocSidebarGroup
      ]
    }),
    tailwind()
  ]
});