bolt-python/docs/docusaurus.config.js at 1acc870561bbf610da864c3724acbc6554ee64b8 · slackapi/bolt-python · 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
import { themes as prismThemes } from 'prism-react-renderer';
const footer = require('./footerConfig');
const navbar = require('./navbarConfig');

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Bolt for Python",
  tagline: "Official frameworks, libraries, and SDKs for Slack developers",
  favicon: "img/favicon.ico",
  url: "https://tools.slack.dev",
  baseUrl: "/bolt-python/",
  organizationName: "slackapi",
  projectName: "bolt-python",

  onBrokenLinks: "ignore",
  onBrokenAnchors: "warn",
  onBrokenMarkdownLinks: "warn",

  i18n: {
    defaultLocale: "en",
    locales: ["en", "ja-jp"],
  },

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          path: "content",
          breadcrumbs: false,
          routeBasePath: "/", // Serve the docs at the site's root
          sidebarPath: "./sidebars.js",
          editUrl: "https://github.com/slackapi/bolt-python/tree/main/docs",
        },
        blog: false,
        theme: {
          customCss: "./src/css/custom.css",
        },
      }),
    ],
  ],

  plugins: [
    "docusaurus-theme-github-codeblock",
    [
      "@docusaurus/plugin-client-redirects",
      {
        redirects: [
          {
            to: "/getting-started",
            from: ["/tutorial/getting-started"],
          },
          {
            to: "/",
            from: ["/concepts", "/concepts/basic", "/concepts/advanced"],
          },
          {
            to: '/concepts/actions',
            from: [
              '/concepts/action-listening',
              '/concepts/action-responding'
            ],
          },
          {
            to: '/legacy/steps-from-apps',
            from: [
              '/concepts/steps',
              '/concepts/creating-steps',
              '/concepts/adding-editing-steps',
              '/concepts/saving-steps',
              '/concepts/executing-steps'
            ],
          },
          {
            to: '/concepts/ai-apps',
            from: '/concepts/assistant'
          }
        ],
      },
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        respectPrefersColorScheme: true,
      },
      docs: {
        sidebar: {
          autoCollapseCategories: true,
        },
      },
      navbar,
      footer,
      prism: {
        // switch to alucard when available in prism?
        theme: prismThemes.github,
        darkTheme: prismThemes.dracula,
      },
      codeblock: {
        showGithubLink: true,
        githubLinkLabel: "View on GitHub",
      },
      // announcementBar: {
      //   id: `announcementBar`,
      //   content: `🎉️ <b><a target="_blank" href="https://api.slack.com/">Version 2.26.0</a> of the developer tools for the Slack automations platform is here!</b> 🎉️ `,
      // },
    }),
};

export default config;