docs/astro.config.js at main · semantic-release/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
// @ts-check
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import tailwindcss from "@tailwindcss/vite";
import starlightPageContextAction from "starlight-page-context-action";

const VERCEL_PREVIEW_SITE =
  process.env.VERCEL_ENV !== "production" &&
  `https://${process.env.VERCEL_BRANCH_URL}`;

const site = VERCEL_PREVIEW_SITE || "https://semantic-release.org/";

// https://astro.build/config
export default defineConfig({
  site,
  integrations: [
    starlight({
      title: "Semantic Release",
      logo: {
        light: "~/assets/sr-logo-light.svg",
        dark: "~/assets/sr-logo-dark.svg",
        replacesTitle: true,
        alt: "Semantic Release",
      },
      editLink: {
        baseUrl: "https://github.com/semantic-release/docs/edit/main/",
      },
      social: [
        {
          icon: "github",
          label: "GitHub",
          href: "https://github.com/semantic-release/semantic-release",
        },
        {
          icon: "npm",
          label: "npm",
          href: "https://www.npmjs.com/package/semantic-release",
        },
      ],
      customCss: ["~/styles/global.css", "@fontsource-variable/geist/wght.css"],
      components: {
        Hero: "~/components/Hero.astro",
        Header: "~/components/Header.astro",
        Head: "~/components/Head.astro",
      },
      sidebar: [
        {
          label: "Introduction",
          slug: "intro",
        },
        {
          label: "Usage",
          items: [
            { slug: "usage/getting-started" },
            { slug: "usage/configuration" },
            { slug: "usage/ci-configuration" },
            { slug: "usage/running" },
          ],
        },
        {
          label: "Foundations",
          items: [
            { slug: "foundation", label: "Overview" },
            { slug: "foundation/how-it-works" },
            { slug: "foundation/release-steps" },
            { slug: "foundation/considerations" },
            { slug: "foundation/supported-branching" },
            { slug: "foundation/workflow-configuration" },
            { slug: "foundation/plugins" },
            { slug: "foundation/shareable-configurations" },
          ],
        },
        {
          label: "Extending",
          items: [
            { slug: "extending/plugins-list" },
            { slug: "extending/shareable-configurations-list" },
          ],
        },
        {
          label: "Recipes",
          items: [
            {
              label: "CI Configurations",
              items: [
                { slug: "recipes/ci-configurations", label: "Overview" },
                { slug: "recipes/ci-configurations/github-actions" },
                { slug: "recipes/ci-configurations/gitlab-ci" },
                {
                  slug: "recipes/ci-configurations/circleci-workflows",
                  label: "CircleCI Workflows",
                },
                { slug: "recipes/ci-configurations/travis" },
                { slug: "recipes/ci-configurations/jenkins-ci" },
              ],
            },
            {
              label: "Git Hosted Services",
              items: [
                { slug: "recipes/git-hosted-services", label: "Overview" },
                { slug: "recipes/git-hosted-services/git-auth-ssh-keys" },
              ],
            },
            {
              label: "Release Workflow",
              items: [
                { slug: "recipes/release-workflow", label: "Overview" },
                { slug: "recipes/release-workflow/distribution-channels" },
                { slug: "recipes/release-workflow/maintenance-releases" },
                { slug: "recipes/release-workflow/pre-releases" },
              ],
            },
          ],
        },
        {
          label: "Developer Guide",
          items: [
            { slug: "developer-guide/js-api" },
            { slug: "developer-guide/plugin" },
            { slug: "developer-guide/shareable-configuration" },
          ],
        },
        {
          label: "Support",
          items: [
            { slug: "support/resources" },
            { slug: "support/faq" },
            { slug: "support/troubleshooting" },
            { slug: "support/node-version" },
            { slug: "support/node-support-policy" },
            { slug: "support/git-version" },
          ],
        },
      ],
      plugins: [
        starlightPageContextAction({
          position: "below-toc",
          sticky: true,
          actions: {
            viewMarkdown: true,
          },
          llmsTxt: true,
        }),
      ],
    }),
  ],

  vite: {
    plugins: [tailwindcss()],
  },
});