websocket.org/astro.config.mjs at main · ably/websocket.org · 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
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import sitemap from '@astrojs/sitemap';

// https://astro.build/config
export default defineConfig({
  site: 'https://websocket.org',
  integrations: [
    sitemap(),
    starlight({
      title: 'WebSocket.org',
      favicon: '/favicon.svg',
      head: [
        {
          tag: 'link',
          attrs: {
            rel: 'icon',
            type: 'image/svg+xml',
            href: '/favicon.svg',
          },
        },
        {
          tag: 'link',
          attrs: {
            rel: 'apple-touch-icon',
            href: '/apple-touch-icon.png',
          },
        },
        {
          tag: 'meta',
          attrs: {
            name: 'theme-color',
            content: '#0d9488',
          },
        },
      ],
      customCss: ['./src/styles/custom.css'],
      social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/ably/websocket.org' }],
      sidebar: [
        {
          label: 'Guides',
          items: [
            {
              label: 'Core Concepts',
              items: [
                { label: 'The Road to WebSockets', link: '/guides/road-to-websockets/' },
                { label: 'WebSocket Protocol', link: '/guides/websocket-protocol/' },
                { label: 'The Future of WebSockets', link: '/guides/future-of-websockets/' },
                { label: 'WebSockets and AI', link: '/guides/websockets-and-ai/' },
              ],
            },
            {
              label: 'Implementation',
              items: [
                { label: 'Building a WebSocket App', link: '/guides/building-a-websocket-app/' },
                { label: 'WebSockets at Scale', link: '/guides/websockets-at-scale/' },
              ],
            },
            {
              label: 'Security',
              items: [{ label: 'Security Hardening', link: '/guides/security/' }],
            },
            {
              label: 'Testing',
              items: [{ label: 'Autobahn TestSuite', link: '/guides/testing/autobahn/' }],
            },
            {
              label: 'Infrastructure',
              items: [
                { label: 'Nginx Configuration', link: '/guides/infrastructure/nginx/' },
                { label: 'AWS ALB Configuration', link: '/guides/infrastructure/aws/alb/' },
                { label: 'Cloudflare Configuration', link: '/guides/infrastructure/cloudflare/' },
                { label: 'Kubernetes Ingress', link: '/guides/infrastructure/kubernetes/' },
              ],
            },
            {
              label: 'Languages',
              collapsed: true,
              items: [
                { label: 'JavaScript & Node.js', link: '/guides/languages/javascript/' },
                { label: 'Python', link: '/guides/languages/python/' },
                { label: 'Go', link: '/guides/languages/go/' },
                { label: 'Rust', link: '/guides/languages/rust/' },
                { label: 'Java', link: '/guides/languages/java/' },
                { label: 'C# & .NET', link: '/guides/languages/csharp/' },
                { label: 'PHP', link: '/guides/languages/php/' },
              ],
            },
          ],
        },
        {
          label: 'Protocol Comparisons',
          collapsed: true,
          items: [
            { label: 'Overview', link: '/comparisons/' },
            { label: 'WebSockets vs HTTP', link: '/comparisons/http/' },
            { label: 'WebSockets vs SSE', link: '/comparisons/sse/' },
            { label: 'WebSockets vs Long Polling', link: '/comparisons/long-polling/' },
            { label: 'WebSockets vs WebTransport', link: '/comparisons/webtransport/' },
            { label: 'WebSockets vs MQTT', link: '/comparisons/mqtt/' },
            { label: 'WebSockets vs WebRTC', link: '/comparisons/webrtc/' },
            { label: 'WebSockets vs gRPC', link: '/comparisons/grpc/' },
            { label: 'Decision Matrix', link: '/comparisons/decision-guide/' },
          ],
        },
        {
          label: 'Reference',
          items: [
            {
              label: 'API Reference',
              items: [
                { label: 'WebSocket API', link: '/reference/websocket-api/' },
                { label: 'Close Codes', link: '/reference/close-codes/' },
              ],
            },
            {
              label: 'Standards',
              items: [{ label: 'Standards Tracker', link: '/standards/' }],
            },
          ],
        },
        {
          label: 'Tools',
          items: [{ label: 'Echo Server', link: '/tools/websocket-echo-server/' }],
        },
        {
          label: 'Resources',
          items: [
            { label: 'WebSocket Resources', link: '/resources/websocket-resources/' },
            { label: 'Community', link: '/resources/community/' },
            { label: '📖 Once Upon a Socket', link: '/once-upon-a-socket' },
          ],
        },
      ],
      editLink: {
        baseUrl: 'https://github.com/ably/websocket.org/edit/main/',
      },
      components: {
        Head: './src/components/head.astro',
        // Sidebar: './src/components/Sidebar.astro',
        ContentPanel: './src/components/ContentWrapper.astro',
        PageFrame: './src/components/PageFrameWrapper.astro',
        PageTitle: './src/components/PageTitle.astro',
        ThemeSelect: './src/components/ThemeSelect.astro',
      },
    }),
  ],
});