/ docusaurus.config.js
docusaurus.config.js
1 // @ts-check 2 // Note: type annotations allow type checking and IDEs autocompletion 3 require("dotenv").config(); 4 5 /** @type {import("@docusaurus/types").Config} */ 6 const config = { 7 title: "Waku Documentation", 8 url: "https://docs.waku.org/", 9 baseUrl: "/", 10 onBrokenLinks: "throw", 11 onBrokenMarkdownLinks: "warn", 12 13 // Even if you don't use internalization, you can use this field to set useful 14 // metadata like html lang. For example, if your site is Chinese, you may want 15 // to replace "en" with "zh-Hans". 16 i18n: { 17 defaultLocale: "en-GB", 18 locales: ["en-GB"], 19 }, 20 presets: [ 21 [ 22 "@acid-info/logos-docusaurus-preset", 23 { 24 businessUnit: "Waku", 25 customSiteConfig: true, 26 docs: { 27 routeBasePath: "/", 28 path: "docs", 29 sidebarPath: require.resolve("./sidebars.js"), 30 editUrl: "https://github.com/waku-org/docs.waku.org/tree/develop/", 31 showLastUpdateTime: true, 32 breadcrumbs: false, 33 }, 34 theme: { 35 name: "default", 36 options: { 37 customCss: [require.resolve("./src/css/custom.scss")], 38 }, 39 }, 40 og: {}, 41 }, 42 ], 43 ], 44 staticDirectories: ["static"], 45 plugins: [ 46 [ 47 "@acid-info/docusaurus-fathom", 48 { 49 siteId: "FUTMI", 50 scriptUrl: "https://fathom.status.im/tracker.js", 51 }, 52 ], 53 ], 54 themeConfig: { 55 colorMode: { 56 disableSwitch: false, 57 respectPrefersColorScheme: true, 58 }, 59 docs: { 60 sidebar: { 61 hideable: false, 62 }, 63 }, 64 navbar: { 65 hideOnScroll: true, 66 items: [ 67 { 68 type: "search", 69 }, 70 { 71 position: "left", 72 label: "Build", 73 to: "/build/javascript/", 74 activeBaseRegex: "^/build/", 75 }, 76 { 77 position: "left", 78 label: "Run Node", 79 to: "/run-node/", 80 activeBaseRegex: "^/run-node/", 81 }, 82 { 83 position: "left", 84 label: "Learn", 85 to: "/learn/", 86 activeBaseRegex: "^/learn/", 87 }, 88 { 89 href: "https://discord.waku.org", 90 position: "left", 91 label: "Discord", 92 }, 93 { 94 href: "https://github.com/waku-org", 95 position: "right", 96 className: "header-github-link", 97 title: "Waku GitHub repository", 98 }, 99 ], 100 }, 101 footer: { 102 copyright: "Waku", 103 links: [ 104 { 105 title: "Community", 106 items: [ 107 { 108 href: "https://twitter.com/waku_org/", 109 label: "X", 110 }, 111 { 112 href: "https://discord.waku.org/", 113 label: "Discord", 114 }, 115 { 116 href: "https://github.com/waku-org/", 117 label: "GitHub", 118 }, 119 { 120 href: "https://www.youtube.com/@wakuorg", 121 label: "YouTube", 122 }, 123 { 124 href: "https://www.linkedin.com/company/waku-org", 125 label: "LinkedIn", 126 }, 127 { 128 href: "https://warpcast.com/waku", 129 label: "Farcaster", 130 }, 131 { 132 href: "https://t.me/waku_org/", 133 label: "Telegram", 134 }, 135 ], 136 }, 137 { 138 title: "Resources", 139 items: [ 140 { 141 href: "https://blog.waku.org/", 142 label: "Blog", 143 }, 144 { 145 href: "https://rfc.vac.dev/waku", 146 label: "Waku RFCs", 147 }, 148 { 149 href: "https://github.com/waku-org/awesome-waku/", 150 label: "Awesome Waku", 151 }, 152 ], 153 }, 154 { 155 title: "Legal", 156 items: [ 157 { 158 href: "/terms", 159 label: "Terms of Use", 160 }, 161 { 162 href: "/privacy-policy", 163 label: "Privacy Policy", 164 }, 165 { 166 href: "/rules-of-engagement", 167 label: "Rules of Engagement", 168 }, 169 { 170 href: "/security", 171 label: "Security", 172 }, 173 ], 174 }, 175 ], 176 }, 177 }, 178 markdown: { 179 mermaid: true, 180 }, 181 }; 182 183 module.exports = config;