summaryrefslogtreecommitdiff
path: root/docs/vitepress.config.ts
blob: 62c7371d18b5d82842b1508dbaaa8613238297fb (plain)
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
import { defineConfig } from 'vitepress'

function reference(lib = "") {
    return `https://aylur.github.io/libastal${lib}`
}

function github(url = "") {
    return `https://github.com/aylur/astal${url}`
}

export default defineConfig({
    title: "Astal",
    description: "Documentation website of the Astal project",

    outDir: "./dist",
    base: "/astal/",
    cleanUrls: true,

    lastUpdated: true,
    ignoreDeadLinks: true, // FIXME:

    head: [
        ['link', { rel: 'icon', href: '/astal/favicon.ico' }],
    ],

    themeConfig: {
        // logo: "",
        //

        nav: [{
            text: '0.1.0',
            items: [
                { text: 'Contributing', link: github("/blob/main/CONTRIBUTING.md") },
                { text: 'Changelog', link: github("/blob/main/CHANGELOG.md") },
            ],
        }],

        sidebar: [
            {
                text: 'Getting Started',
                base: "/getting-started",
                collapsed: false,
                items: [
                    { text: 'Introduction', link: '/introduction' },
                    { text: 'Installation', link: '/installation' },
                    { text: 'Supported Languages', link: '/supported-languages' },
                ],
            },
            {
                text: 'AGS',
                base: "/ags",
                collapsed: false,
                items: [
                    { text: 'First Widgets', link: '/first-widgets' },
                    { text: 'Theming', link: '/theming' },
                    { text: 'CLI and App', link: '/cli-app' },
                    { text: 'Widget', link: '/widget' },
                    { text: 'Utilities', link: '/utilities' },
                    { text: 'Variable', link: '/variable' },
                    { text: 'FAQ', link: '/faq' },
                ],
            },
            {
                text: 'Libraries',
                collapsed: true,
                items: [
                    { text: 'References', link: '/libraries/references' },
                    { text: "Astal", link: reference("") },
                    { text: "Apps", link: reference("/apps") },
                    { text: "Auth", link: reference("/auth") },
                    { text: "Battery", link: reference("/battery") },
                    { text: "Bluetooth", link: reference("/bluetooth") },
                    { text: "Hyprland", link: reference("/hyprland") },
                    { text: "Mpris", link: reference("/mpris") },
                    { text: "Network", link: reference("/network") },
                    { text: "Notifd", link: reference("/notifd") },
                    { text: "PowerProfiles", link: reference("/powerprofiles") },
                    { text: "River", link: reference("/river") },
                    { text: "Tray", link: reference("/tray") },
                    { text: "WirePlumber", link: reference("/wireplumber") },
                ],
            },
        ],

        socialLinks: [
            { icon: 'github', link: github() },
            { icon: 'discord', link: '"https://discord.gg/CXQpHwDuhY"' },
        ],

        editLink: {
            pattern: github("edit/main/docs/:path"),
            text: 'Edit this page on GitHub',
        },

        lastUpdated: {
            text: 'Last updated',
        },

        search: {
            provider: "local",
        }
    },
})