sidequest/packages/docs/.vitepress/config.mts at 673e044aae464e09bc314b53a0aae18d838c8999 · sidequestjs/sidequest · 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
import { defineConfig } from "vitepress";

// https://vitepress.dev/reference/site-config
export default defineConfig({
  title: "Sidequest.js",
  description: "Robust distributed job processing for Node.js",
  lang: "en-US",
  cleanUrls: true,
  head: [
    ["link", { rel: "icon", href: "/logo-modern.png" }],
    ["script", { async: "", src: `https://www.googletagmanager.com/gtag/js?id=${process.env.VITE_GA_TAG}` }],
    [
      "script",
      {},
      `window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', '${process.env.VITE_GA_TAG}');`,
    ],
  ],
  themeConfig: {
    // https://vitepress.dev/reference/default-theme-config
    nav: [
      { text: "Home", link: "/" },
      { text: "Docs", link: "/overview" },
    ],

    sidebar: [
      { text: "🔭 Overview", link: "/overview" },
      { text: "📦 Installation", link: "/installation" },
      { text: "🚀 Quick Start", link: "/quick-start" },
      { text: "💻 CLI", link: "/cli" },
      {
        text: "💼 Jobs",
        base: "/jobs",
        link: "/",
        collapsed: false,
        items: [
          {
            text: "Lifecycle",
            link: "/lifecycle",
          },
          {
            text: "Job Class",
            link: "/class",
          },
          {
            text: "Job.run Method",
            link: "/run-method",
          },
          {
            text: "Convenience Methods",
            link: "/convenience-methods",
          },
          {
            text: "Recurring Jobs",
            link: "/recurring",
          },
          {
            text: "Logging",
            link: "/logging",
          },
        ],
      },
      {
        text: "🛣️ Queues",
        base: "/queues",
        link: "/",
        collapsed: false,
        items: [
          {
            text: "States",
            link: "/states",
          },
          {
            text: "Priority",
            link: "/priority",
          },
          {
            text: "Concurrency",
            link: "/concurrency",
          },
        ],
      },
      {
        text: "⚙️ Engine",
        base: "/engine",
        link: "/",
        collapsed: false,
        items: [
          {
            text: "Configuration",
            link: "/configuration",
          },
          {
            text: "Starting the Engine",
            link: "/starting",
          },
          {
            text: "Enqueueing Jobs",
            link: "/enqueue",
          },
          {
            text: "Graceful Shutdown",
            link: "/graceful-shutdown",
          },
          {
            text: "Cleaning Up Jobs",
            link: "/cleanup",
          },
        ],
      },
      { text: "🌐 Dashboard", link: "/dashboard" },
      { text: "🧑‍💻 Development", link: "/development" },
      { text: "⚒️ Examples", link: "/examples" },
    ],

    socialLinks: [{ icon: "github", link: "https://github.com/sidequestjs/sidequest" }],

    logo: "logo.png",

    footer: {
      message: "Released under the LGPL-3.0 License.",
      copyright: "Copyright © 2025 Lucas Merencia and Giovani Guizzo",
    },
  },
});