stackyard-docs/astro.config.mjs at main · SandObserver/stackyard-docs · 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
// @ts-check
import { defineConfig } from 'astro/config';

import starlight from '@astrojs/starlight';
import rehypeExternalLinks from 'rehype-external-links';
import rehypeTableScroll from './src/lib/rehype-table-scroll.mjs';
import mdx from '@astrojs/mdx';

const SITE = 'https://stackyard.sandobserver.com';

export default defineConfig({
  site: SITE,
  redirects: {
    '/docs/development': '/docs/contributing/',
    '/docs/adding-services': '/docs/apps-and-folders/',
    '/docs/advanced-configuration': '/docs/installation/docker/',
    '/docs/widgets/github': '/docs/widgets/git/',
  },
  markdown: {
    rehypePlugins: [
      [rehypeExternalLinks, { target: '_blank', rel: ['noopener', 'noreferrer'] }],
      rehypeTableScroll,
    ],
  },
  integrations: [
    starlight({
      title: 'Stackyard',
      description:
        'A calm, customizable dashboard for your services, designed to be useful without becoming another wall of data.',
      logo: {
        light: './public/img/stackyard-wordmark-light-b3140d1e.svg',
        dark: './public/img/stackyard-wordmark-dark-4680834d.svg',
        alt: '',
        replacesTitle: true,
      },
      favicon: '/favicon.svg',
      components: {
        Head: './src/components/Head.astro',
        Sidebar: './src/components/Sidebar.astro',
      },
      customCss: ['./src/styles/docs.css'],
      head: [
        { tag: 'link', attrs: { rel: 'apple-touch-icon', href: '/apple-touch-icon.png' } },
        { tag: 'link', attrs: { rel: 'manifest', href: '/manifest.webmanifest' } },
        { tag: 'meta', attrs: { name: 'theme-color', content: '#0d1117' } },
        { tag: 'meta', attrs: { property: 'og:image', content: `${SITE}/img/og-2f94d569.jpg` } },
        { tag: 'meta', attrs: { property: 'og:image:width', content: '1200' } },
        { tag: 'meta', attrs: { property: 'og:image:height', content: '630' } },
        { tag: 'meta', attrs: { property: 'og:site_name', content: 'Stackyard' } },
        { tag: 'meta', attrs: { name: 'twitter:card', content: 'summary_large_image' } },
        { tag: 'meta', attrs: { name: 'twitter:image', content: `${SITE}/img/og-2f94d569.jpg` } },
      ],

      expressiveCode: {
        themes: ['github-dark', 'github-light'],
        styleOverrides: {
          borderRadius: '14px',
          borderWidth: '1px',
          codePaddingBlock: '0.9rem',
          frames: {
            editorActiveTabBackground: 'transparent',
            frameBoxShadowCssValue: 'none',
          },
        },
        defaultProps: { frame: 'none' },
      },
      social: [
        { icon: 'github', label: 'GitHub', href: 'https://github.com/SandObserver/stackyard' },
      ],
      editLink: {
        baseUrl: 'https://github.com/SandObserver/stackyard-docs/edit/main/',
      },
      sidebar: [
        {
          label: 'Get started',
          items: [
            { label: 'Introduction', link: '/docs/' },
            { label: 'Comparison', link: '/docs/is-stackyard-for-you/' },
            { label: 'Install with Docker', link: '/docs/installation/docker/' },
            { label: 'Install on Unraid', link: '/docs/installation/unraid/' },
            { label: 'Build from source', link: '/docs/installation/build-from-source/' },
            { label: 'First setup', link: '/docs/first-setup/' },
          ],
        },
        {
          label: 'Build your dashboard',
          items: [
            { label: 'Add apps and folders', link: '/docs/apps-and-folders/' },
            { label: 'Show status badges', link: '/docs/badges/' },
            { label: 'Wallpaper and themes', link: '/docs/customization/' },
          ],
        },
        {
          label: 'Widgets',
          collapsed: true,
          items: [
            { label: 'Overview', link: '/docs/widgets/' },
            { label: 'Backup', link: '/docs/widgets/backup/' },
            { label: 'Books', link: '/docs/widgets/books/' },
            { label: 'Clock', link: '/docs/widgets/clock/' },
            { label: 'Connections', link: '/docs/widgets/connections/' },
            { label: 'Custom', link: '/docs/widgets/custom/' },
            { label: 'Dashboard switch', link: '/docs/widgets/dashboard-switch/' },
            { label: 'Disk health', link: '/docs/widgets/disk-health/' },
            { label: 'DNS', link: '/docs/widgets/dns/' },
            { label: 'Downloads', link: '/docs/widgets/downloads/' },
            { label: 'Git', link: '/docs/widgets/git/' },
            { label: 'Now Playing', link: '/docs/widgets/now-playing/' },
            { label: 'System summary', link: '/docs/widgets/system-summary/' },
            { label: 'Up Next', link: '/docs/widgets/up-next/' },
            { label: 'Weather', link: '/docs/widgets/weather/' },
          ],
        },
        {
          label: 'Run Stackyard',
          items: [
            { label: 'Back up and restore', link: '/docs/import-export/backup-and-restore/' },
            { label: 'Import', link: '/docs/import-export/migrating/' },
            { label: 'Use a reverse proxy', link: '/docs/reverse-proxy/' },
            { label: 'Security', link: '/docs/security/' },
          ],
        },
        { label: 'Settings', link: '/docs/settings-reference/' },
        { label: 'Troubleshooting', link: '/docs/troubleshooting/' },
        {
          label: 'Create a widget',
          collapsed: true,
          items: [
            { label: 'Build your first widget', link: '/docs/create-a-widget/' },
            { label: 'Manifest', link: '/docs/create-a-widget/manifest/' },
            { label: 'Data', link: '/docs/create-a-widget/data/' },
            { label: 'Widget page', link: '/docs/create-a-widget/widget-page/' },
            { label: 'Checklist', link: '/docs/create-a-widget/checklist/' },
          ],
        },
        {
          label: 'Contributing',
          collapsed: true,
          items: [
            { label: 'How to contribute', link: '/docs/contributing/' },
            { label: 'Architecture', link: '/docs/contributing/architecture/' },
            { label: 'Design system', link: '/docs/contributing/design-system/' },
            { label: 'Translations', link: '/docs/contributing/translations/' },
            { label: 'API errors', link: '/docs/contributing/api-errors/' },
            { label: 'Other clients', link: '/docs/contributing/other-clients/' },
            { label: 'Releasing', link: '/docs/contributing/releasing/' },
          ],
        },
        {
          label: 'About',
          collapsed: true,
          items: [
            { label: 'Accessibility', link: '/docs/accessibility/' },
            { label: 'Security policy', link: '/docs/security-policy/' },
            { label: 'Governance', link: '/docs/governance/' },
            { label: 'Support', link: '/docs/support/' },
            { label: 'Changelog', link: '/docs/changelog/' },
          ],
        },
      ],
    }),
    mdx(),
  ],
});