charity-api-docs/docusaurus.config.js at main · everydotorg/charity-api-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
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Every.org Charity API Docs",
  tagline:
    "Use Every.org's free Charity API to create innovative giving experiences.",
  url: "https://docs.every.org",
  baseUrl: "/",
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/favicon.ico",
  organizationName: "everydotorg", // Usually your GitHub org/user name.
  projectName: "charity-api-docs", // Usually your repo name.

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          editUrl: "https://github.com/everydotorg/charity-api-docs",
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      }),
    ],
  ],

  plugins: [
    [
      "@docusaurus/plugin-client-redirects",
      {
        redirects: [
          {
            from: "/docs/endpoints/nonprofit-search",
            to: "/docs/endpoints/nonprofits",
          },
        ],
      },
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        title: "Every.org Charity API",
        logo: {
          alt: "Every.org Logo",
          src: "img/logo.svg",
        },
        items: [
          {
            type: "doc",
            docId: "intro",
            position: "left",
            label: "Docs",
          },
          {
            href: "https://github.com/everydotorg/",
            label: "Github",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "Docs",
            items: [
              {
                label: "Intro",
                to: "/docs/intro",
              },
              {
                label: "Authentication",
                to: "/docs/endpoints/authentication"
              },
              {
                label: "Nonprofits",
                to: "/docs/endpoints/nonprofits"
              },
              {
                label: "Fundraisers",
                to: "/docs/endpoints/fundraisers"
              },
              {
                label: "Donate Button",
                to: "/docs/donate-button"
              },
              {
                label: "Donate Link",
                to: "/docs/donate-link"
              },
              {
                label: "Webhooks",
                to: "/docs/webhooks"
              }
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Every.org.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
      // See docs at https://docusaurus.io/docs/search#connecting-algolia
      algolia: {
        // The application ID provided by Algolia
        appId: 'NQG6UYJ0XB',
        // Public API key: it is safe to commit it
        apiKey: 'a8f2018501bed7871adaec4b5fc13fbe',
        indexName: 'every',
        contextualSearch: true,

        // Optional: path for search page that is enabled by default (`false` to
        // disable it)
        searchPagePath: 'search',
      },

    }),
};

module.exports = config;