vuejs-tour/docs/.vitepress/config.ts at ba4c32d5eda2b0208f5a611d7a8c854e83ecefaf · AdamDrewsTR/vuejs-tour · 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
import { defineConfig } from 'vitepress';

export default defineConfig({
  title: 'VueJS Tour',
  description: 'Guide your users through your application quickly and easily.',
  lang: 'en-US',
  base: '/vuejs-tour/',
  vite: {
    css: {
      preprocessorOptions: {
        scss: {
          api: 'modern-compiler',
        },
      },
    },
  },
  themeConfig: {
    logo: 'https://vuejs.org/images/logo.png',
    nav: [
      { text: 'Guide', link: '/guide/what-is-vuejs-tour' },
      {
        text: '2.5.0',
        items: [
          {
            text: 'Changelog',
            link: 'https://github.com/GlobalHive/vuejs-tour/blob/master/CHANGELOG.md',
          },
          { text: 'Roadmap', link: '/guide/roadmap' },
          {
            text: 'Issues',
            link: 'https://github.com/GlobalHive/vuejs-tour/issues',
          },
        ],
      },
    ],
    sidebar: {
      '/guide/': [
        {
          text: 'Introduction',
          collapsed: false,
          items: [
            { text: 'What is VueJS Tour?', link: '/guide/what-is-vuejs-tour' },
            { text: 'Getting Started', link: '/guide/getting-started' },
            { text: 'Create a Tour', link: '/guide/create-a-tour' },
          ],
        },
        {
          text: 'Customization',
          collapsed: false,
          items: [
            {
              text: 'VTour Component',
              items: [
                { text: 'Start Options', link: '/guide/start-options' },
                { text: 'Highlight Target', link: '/guide/highlight-target' },
                { text: 'Using a Backdrop', link: '/guide/using-a-backdrop' },
                { text: 'Hiding the Arrow', link: '/guide/hiding-the-arrow' },
                { text: 'Tour Margin', link: '/guide/tour-margin' },
                { text: 'Saving Progress', link: '/guide/saving-progress' },
                { text: 'Scroll to Element', link: '/guide/scroll-to-element' },
              ],
            },
            {
              text: 'Step Options',
              items: [
                { text: 'The Step Type', link: '/guide/the-step-type' },
                { text: 'Setting a Target', link: '/guide/setting-a-target' },
                {
                  text: 'Define the Content',
                  link: '/guide/define-the-content',
                },
                { text: 'Using Placement', link: '/guide/using-placement' },
                {
                  text: 'The onBefore Event',
                  link: '/guide/the-onbefore-event',
                },
                { text: 'The onAfter Event', link: '/guide/the-onafter-event' },
                {
                  text: 'Highlight Target',
                  link: '/guide/step-highlight-target',
                },
                {
                  text: 'Using a Backdrop',
                  link: '/guide/step-using-a-backdrop',
                },
                {
                  text: 'Scroll to Element',
                  link: '/guide/step-scroll-to-element',
                },
              ],
            },
          ],
        },
        {
          text: 'Advanced',
          collapsed: false,
          items: [
            { text: 'Skipping a Tour', link: '/guide/skipping-a-tour' },
            { text: 'Button Labels', link: '/guide/button-labels' },
            { text: 'Multiple Tours', link: '/guide/multiple-tours' },
            { text: 'Jump Options', link: '/guide/jump-options' },
            { text: 'Accessibility', link: '/guide/accessibility' },
            {
              text: 'Styling',
              items: [
                { text: 'CSS Theme', link: '/guide/css-theme' },
                { text: 'Component Slots', link: '/guide/component-slots' },
              ],
            },
          ],
        },
        {
          text: "What's next?",
          collapsed: false,
          items: [
            { text: 'Roadmap', link: '/guide/roadmap' },
            {
              text: 'Changelog',
              link: 'https://github.com/GlobalHive/vuejs-tour/blob/master/CHANGELOG.md',
            },
          ],
        },
      ],
      '/reference/': [
        {
          text: 'Reference',
          collapsed: false,
          items: [{ text: 'Coming Soon', link: '/reference/coming-soon' }],
        },
      ],
    },
    socialLinks: [
      { icon: 'github', link: 'https://github.com/GlobalHive/vuejs-tour' },
    ],
    footer: {
      message: 'Released under the MIT License.',
      copyright:
        'Made with ❤️ by <a href = "https://github.com/GlobalHive/vuejs-tour">Global Hive</a>',
    },
    editLink: {
      pattern:
        'https://github.com/GlobalHive/vuejs-tour/tree/master/docs/:path',
      text: 'Edit this page on GitHub',
    },
  },
});