docs/docusaurus.config.ts at main · smithy-security/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
import {themes as prismThemes} from "prism-react-renderer";
import type {Config} from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";

const config: Config = {
    title: "Smithy Docs",
    tagline: "Learn how to use Smithy",
    favicon: "img/favicon.png",

    url: "https://docs.smithy.security",
    baseUrl: "/",

    // GitHub pages deployment config.
    organizationName: "smithy-security",
    projectName: "docs",
    trailingSlash: false,

    onBrokenLinks: "throw",
    markdown: {
        hooks: {
            onBrokenMarkdownLinks: "warn",
        }
    },
    i18n: {
        defaultLocale: "en",
        locales: ["en"],
    },
    presets: [
        [
            "classic",
            {
                docs: {
                    sidebarPath: "./sidebars.ts",
                    editUrl: "https://github.com/smithy-security/docs/tree/main/",
                },
                theme: {
                    customCss: "./src/css/custom.css",
                },
            } satisfies Preset.Options,
        ],
    ],

    themeConfig: {
        image: "img/social-card.png",
        navbar: {
            title: "Docs",
            logo: {
                alt: "Smithy Logo",
                src: "img/logo.svg",
            },
            items: [
                {
                    position: "left",
                    label: "SaaS",
                    to: "/docs/category/saas",
                },
                {
                    position: "left",
                    label: "Reference",
                    to: "/docs/category/reference",
                },
                {
                    href: "https://github.com/smithy-security/docs",
                    label: "GitHub",
                    position: "right",
                },
            ],
        },
        footer: {
            links: [
                {
                    title: "Docs",
                    items: [
                        {
                            label: "SaaS",
                            to: "/docs/category/saas",
                        },
                        {
                            label: "Reference",
                            to: "/docs/category/reference",
                        },
                    ],
                },
                {
                    title: "Community",
                    items: [
                        {
                            label: "Discord",
                            href: "https://discord.gg/zDUQRhtxhn",
                        },
                    ],
                },
                {
                    title: "More",
                    items: [
                        {
                            label: "GitHub",
                            href: "https://github.com/smithy-security/docs",
                        },
                    ],
                },
            ],
            copyright: `Copyright © ${new Date().getFullYear()} SPF Security Solutions Ltd. Built with Docusaurus.`,
        },
        prism: {
            theme: prismThemes.github,
            darkTheme: prismThemes.dracula,
            additionalLanguages: ["bash", "docker", "makefile"],
        },
    } satisfies Preset.ThemeConfig,

    plugins: [require.resolve('docusaurus-lunr-search')],
};

export default config;