squawk/docs/docusaurus.config.js at 300be4ed8173a7d671be13bc9523f91ffc5f8895 · sbdchd/squawk · 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
module.exports = {
  title: "Squawk — a linter for Postgres migrations",
  tagline: "Reveal blocking schema changes with the Squawk CLI and GitHub App.",
  url: "https://squawkhq.com",
  baseUrl: "/",
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/owl.png",
  organizationName: "sbdchd", // Usually your GitHub org/user name.
  projectName: "squawk", // Usually your repo name.
  themeConfig: {
    prism: {
      additionalLanguages: ['toml'],
      theme: require('prism-react-renderer/themes/oceanicNext'),
    },
    algolia: {
      appId: process.env.ALGOLIA_APP_ID,
      apiKey: process.env.ALGOLIA_API_KEY,
      indexName: process.env.ALGOLIA_INDEX_NAME,
    },
    sidebarCollapsible: false,
    colorMode: {
      defaultMode: "light",
      disableSwitch: true,
      respectPrefersColorScheme: false,
    },
    image: 'img/squawk-wordmark.png',
    metadatas: [
      {
        name: 'title',
        content: 'Squawk — a linter for Postgres migrations'
      },
      {
        name: 'description',
        content: 'Reveal blocking schema changes with the Squawk CLI and GitHub App.'
      },
    ],
    navbar: {
      title: "Squawk",
      logo: {
        alt: "Squawk Logo",
        src: "img/owl.png",
      },
      items: [
        {
          to: "docs/",
          label: "Docs",
          position: "left",
        },
        {
          to: "docs/rules",
          activeBasePath: "docs/rules",
          label: "Rules",
          position: "left",
        },
        {
          href: "https://play.squawkhq.com",
          label: "Playground",
          position: "right",
        },
        {
          to: "docs/",
          label: "Quick Start",
          position: "right",
        },
        {
          href: "https://github.com/sbdchd/squawk",
          label: "GitHub",
          position: "right",
        },
      ],
    },
    footer: {
      style: "dark",
      links: [
        {
          title: "Docs",
          items: [
            {
              label: "Quick Start",
              to: "docs/",
            },
            {
              label: "Rules",
              to: "docs/rules",
            },
          ],
        },
        {
          title: "More",
          items: [
            {
              label: "GitHub",
              href: "https://github.com/sbdchd/squawk",
            },
            {
              label: "Changelog",
              href: "https://github.com/sbdchd/squawk/blob/master/CHANGELOG.md",
            },
            {
              label: "Help",
              href: "https://github.com/sbdchd/squawk/issues/new",
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} Squawk Authors.`,
    },
  },
  presets: [
    [
      "@docusaurus/preset-classic",
      {
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          // Please change this to your repo.
          editUrl: "https://github.com/sbdchd/squawk/edit/master/docs/",
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      },
    ],
  ],
}