juice-docs/docusaurus.config.js at master · jbx-protocol/juice-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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
// @ts-check
// See: https://docusaurus.io/docs/api/docusaurus-config

import { themes as prismThemes } from "prism-react-renderer";

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Juice Docs",
  tagline: "Fund your thing.",
  url: "https://docs.juicebox.money",
  baseUrl: "/",
  favicon: "img/logo/icon-logo-black.svg",
  trailingSlash: true,

  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "throw",


  plugins: [
    [
      "@docusaurus/plugin-content-blog",
      {
        id: "town-hall",
        routeBasePath: "town-hall",
        path: "./town-hall",
        showReadingTime: true,
        editUrl: "https://github.com/jbx-protocol/juice-docs-v3/blob/main",
        blogSidebarTitle: "Town Halls",
        blogSidebarCount: "ALL",
        authorsMapPath: "../blog/authors.yml",
      },
    ],
  ],

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: "./sidebars.js",
          routeBasePath: "/",
          editUrl: "https://github.com/jbx-protocol/juice-docs-v3/blob/main",
        },
        blog: {
          showReadingTime: true,
          routeBasePath: "blog",
          editUrl: "https://github.com/jbx-protocol/juice-docs/blob/main",
          blogSidebarTitle: "Articles",
          blogSidebarCount: "ALL",
          feedOptions: {
            type: "all",
            copyright: "Licensed under the MIT License",
          },
        },
        theme: {
          customCss: "./src/css/custom.css",
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // Replace with your project's social card
      image: "img/site/unfurl.png",
      navbar: {
        logo: {
          alt: "Juicebox Logo",
          src: "img/logo/main-logo-black.svg",
        },
        items: [
          {
            type: "docSidebar",
            position: "left",
            sidebarId: "dev",
            label: "Developers",
          },
          {
            type: "docSidebar",
            position: "left",
            sidebarId: "dao",
            label: "JBX",
          },
          {
            type: "dropdown",
            label: "Links",
            position: "right",
            items: [
              {
                label: "Juicebox",
                to: "https://juicebox.money",
              },
              {
                label: "Contact",
                to: "https://juicebox.money/contact",
              },
              {
                label: "Discord",
                to: "https://discord.gg/juicebox",
              },
              {
                label: "GitHub",
                to: "https://github.com/jbx-protocol",
              },
              {
                label: "Telegram",
                to: "https://t.me/jbx_eth",
              },
              {
                label: "Governance",
                to: "https://jbdao.org",
              },
              {
                label: "X",
                to: "https://x.com/juiceboxETH",
              },
              {
                label: "YouTube",
                to: "https://www.youtube.com/c/JuiceboxDAO/",
              },
              {
                label: "Newsletter",
                to: "https://subscribepage.io/juicenews",
              },
              {
                label: "Podcast",
                to: "https://anchor.fm/thejuicecast",
              },
            ],
          },
        ],
      },
      docs: {
        sidebar: {
          autoCollapseCategories: true,
        },
      },
      colorMode: {
        defaultMode: "dark",
        respectPrefersColorScheme: true,
      },
      tableOfContents: {
        minHeadingLevel: 2,
        maxHeadingLevel: 5,
      },
      prism: {
        theme: prismThemes.oneLight,
        darkTheme: prismThemes.oneDark,
        defaultLanguage: "solidity",
        additionalLanguages: ["solidity"],
      },
      algolia: {
        appId: "6C0XLHGK46",
        apiKey: "cf4910b7f8d618e1ee356e575db8120b",
        indexName: "juicebox",
        searchParameters: {
          // Boost v5 results by using optionalFilters
          // If your Algolia index has a 'version' attribute or facet, uncomment:
          // optionalFilters: ['version:v5'],
          //
          // Alternatively, if you have a custom ranking attribute set up in Algolia dashboard:
          // This requires configuring custom ranking in Algolia dashboard:
          // 1. Go to Algolia Dashboard > Indices > juicebox > Ranking
          // 2. Add a custom ranking attribute (e.g., 'version_priority')
          // 3. Set v5 docs to have higher priority values
          // 4. Then use: optionalFilters: ['version_priority:>5'],
        },
        // Contextual search can help with relevance
        contextualSearch: true,
      }
    }),
};

export default config;