|
| 1 | +const { resolve } = require("path"); |
| 2 | +const themeConfig = require("@spiralbtc/vuepress-devkit-theme/config"); |
| 3 | + |
| 4 | +const title = "Lightning Dev Kit Documentation"; |
| 5 | +const baseUrl = "https://lightningdevkit.org"; |
| 6 | +const githubUrl = "https://github.com/lightningdevkit"; |
| 7 | +const discordUrl = "https://discord.gg/5AcknnMfBw"; |
| 8 | +const themeColor = "#ffffff"; |
| 9 | + |
| 10 | +const docsSidebar = [ |
| 11 | + { |
| 12 | + title: "Documentation", |
| 13 | + collapsable: false, |
| 14 | + children: [ |
| 15 | + { |
| 16 | + title: "Introduction", |
| 17 | + path: "/introduction/", |
| 18 | + collapsable: true, |
| 19 | + children: [ |
| 20 | + ["/introduction/use-cases", "Use Cases"], |
| 21 | + ["/introduction/architecture", "Architecture"], |
| 22 | + ["/introduction/peer-management", "Peer Management"], |
| 23 | + ["/introduction/persistent_storage", "Persistent Storage"], |
| 24 | + ["/introduction/blockchain_data", "Blockchain Data"], |
| 25 | + ["/introduction/wallet_management", "Wallet Management"], |
| 26 | + ["/introduction/networking", "Networking"], |
| 27 | + ["/introduction/private_key_management", "Private Key Management"], |
| 28 | + ["/introduction/transactions", "Transactions"], |
| 29 | + ["/introduction/random_number_generation", "Random Number Generation"], |
| 30 | + ], |
| 31 | + }, |
| 32 | + { |
| 33 | + title: "Building a node with LDK", |
| 34 | + collapsable: true, |
| 35 | + children: [ |
| 36 | + ["/building-a-node-with-ldk/introduction", "Introduction"], |
| 37 | + ["/building-a-node-with-ldk/installation", "Installation"], |
| 38 | + [ |
| 39 | + "/building-a-node-with-ldk/setting-up-a-channel-manager", |
| 40 | + "Setting up a Channel Manager", |
| 41 | + ], |
| 42 | + [ |
| 43 | + "/building-a-node-with-ldk/handling-events", |
| 44 | + "Handling Events", |
| 45 | + ], |
| 46 | + [ |
| 47 | + "/building-a-node-with-ldk/setting-up-a-peer-manager", |
| 48 | + "Setting up a Peer Manager", |
| 49 | + ], |
| 50 | + [ |
| 51 | + "/building-a-node-with-ldk/connect-to-peers", |
| 52 | + "Connect to Peers", |
| 53 | + ], |
| 54 | + [ |
| 55 | + "/building-a-node-with-ldk/opening-a-channel", |
| 56 | + "Opening a Channel", |
| 57 | + ], |
| 58 | + [ |
| 59 | + "/building-a-node-with-ldk/sending-payments", |
| 60 | + "Sending Payments", |
| 61 | + ], |
| 62 | + [ |
| 63 | + "/building-a-node-with-ldk/receiving-payments", |
| 64 | + "Receiving Payments", |
| 65 | + ], |
| 66 | + [ |
| 67 | + "/building-a-node-with-ldk/closing-a-channel", |
| 68 | + "Closing a Channel", |
| 69 | + ], |
| 70 | + ], |
| 71 | + }, |
| 72 | + "/running-a-sample-ldk-node", |
| 73 | + { |
| 74 | + title: "Blockchain Data", |
| 75 | + collapsable: true, |
| 76 | + children: [ |
| 77 | + ["/blockchain_data/introduction", "Introduction"], |
| 78 | + ["/blockchain_data/chain_activity", "Chain Activity"], |
| 79 | + ["/blockchain_data/block_source", "Block Source"], |
| 80 | + ["/blockchain_data/full_blocks", "Full Blocks"], |
| 81 | + ["/blockchain_data/pre_filtered_blocks", "Pre-filtered Blocks"], |
| 82 | + ["/blockchain_data/confirmed_transactions", "Confirmed Transactions"], |
| 83 | + [ |
| 84 | + "/blockchain_data/transaction_broadcasting", |
| 85 | + "Transaction Broadcasting", |
| 86 | + ], |
| 87 | + ], |
| 88 | + }, |
| 89 | + "/key_management", |
| 90 | + "/examples", |
| 91 | + ], |
| 92 | + }, |
| 93 | + { |
| 94 | + title: "API Reference", |
| 95 | + collapsable: false, |
| 96 | + children: [ |
| 97 | + { |
| 98 | + title: "Rust", |
| 99 | + collapsable: true, |
| 100 | + children: [ |
| 101 | + ["https://docs.rs/lightning/*/lightning/", "lightning"], |
| 102 | + [ |
| 103 | + "https://docs.rs/lightning-background-processor/*/lightning_background_processor/", |
| 104 | + "lightning-background-processor", |
| 105 | + ], |
| 106 | + [ |
| 107 | + "https://docs.rs/lightning-block-sync/*/lightning_block_sync/", |
| 108 | + "lightning-block-sync", |
| 109 | + ], |
| 110 | + [ |
| 111 | + "https://docs.rs/lightning-invoice/*/lightning_invoice/", |
| 112 | + "lightning-invoice", |
| 113 | + ], |
| 114 | + [ |
| 115 | + "https://docs.rs/lightning-net-tokio/*/lightning_net_tokio/", |
| 116 | + "lightning-net-tokio", |
| 117 | + ], |
| 118 | + [ |
| 119 | + "https://docs.rs/lightning-persister/*/lightning_persister/", |
| 120 | + "lightning-persister", |
| 121 | + ], |
| 122 | + [ |
| 123 | + "https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/", |
| 124 | + "lightning-rapid-gossip-sync", |
| 125 | + ], |
| 126 | + [ |
| 127 | + "https://docs.rs/lightning-transaction-sync/*/lightning_transaction_sync/", |
| 128 | + "lightning-transaction-sync", |
| 129 | + ], |
| 130 | + [ |
| 131 | + "https://docs.rs/lightning-custom-message/*/lightning_custom_message/", |
| 132 | + "lightning-custom-message", |
| 133 | + ], |
| 134 | + ], |
| 135 | + }, |
| 136 | + [ |
| 137 | + "https://github.com/arik-so/SwiftLightning/tree/master/Documentation", |
| 138 | + "Swift", |
| 139 | + ], |
| 140 | + ], |
| 141 | + }, |
| 142 | +]; |
| 143 | + |
| 144 | + |
| 145 | +const blogSidebar = [ |
| 146 | + { |
| 147 | + title: "Blog", |
| 148 | + collapsable: false, |
| 149 | + children: [ |
| 150 | + ["/blog/", "Articles"], |
| 151 | + ["/blog/tags/", "Tags"], |
| 152 | + ["/blog/author/", "Authors"], |
| 153 | + ], |
| 154 | + }, |
| 155 | +]; |
| 156 | + |
| 157 | +module.exports = { |
| 158 | + title, |
| 159 | + description: |
| 160 | + "LDK is a flexible lightning implementation with supporting batteries (or modules).", |
| 161 | + theme: resolve( |
| 162 | + __dirname, |
| 163 | + "../../node_modules/@spiralbtc/vuepress-devkit-theme" |
| 164 | + ), |
| 165 | + ...themeConfig({ |
| 166 | + baseUrl, |
| 167 | + title, |
| 168 | + themeColor, |
| 169 | + tags: ["Bitcoin", "Lightning", "LDK", "Lightning Dev Kit", "Documentation"], |
| 170 | + }), |
| 171 | + themeConfig: { |
| 172 | + domain: baseUrl, |
| 173 | + logo: "/img/logo.svg", |
| 174 | + displayAllHeaders: false, |
| 175 | + repo: "lightningdevkit/lightningdevkit.org", |
| 176 | + docsDir: "docs", |
| 177 | + docsBranch: "main", |
| 178 | + editLinks: true, |
| 179 | + sidebarDepth: 0, |
| 180 | + algolia: { |
| 181 | + indexName: "lightningdevkit", |
| 182 | + appId: "BH4D9OD16A", |
| 183 | + apiKey: "17ed8a4e16a1cb7d94da4e96f2ff817f", |
| 184 | + // See https://www.algolia.com/doc/api-reference/api-parameters/ |
| 185 | + algoliaOptions: { |
| 186 | + typoTolerance: "min", |
| 187 | + }, |
| 188 | + // See https://community.algolia.com/docsearch/behavior.html#autocompleteoptions |
| 189 | + autocompleteOptions: { |
| 190 | + openOnFocus: true, |
| 191 | + }, |
| 192 | + }, |
| 193 | + nav: [ |
| 194 | + { |
| 195 | + text: "Docs", |
| 196 | + link: "/introduction/", |
| 197 | + }, |
| 198 | + { |
| 199 | + text: "Case Studies", |
| 200 | + link: "/case-studies/", |
| 201 | + }, |
| 202 | + { |
| 203 | + text: "Blog", |
| 204 | + link: "/blog/", |
| 205 | + }, |
| 206 | + { |
| 207 | + text: "Discord", |
| 208 | + link: discordUrl, |
| 209 | + rel: "noopener noreferrer", |
| 210 | + }, |
| 211 | + { |
| 212 | + text: "GitHub", |
| 213 | + link: githubUrl, |
| 214 | + rel: "noopener noreferrer", |
| 215 | + }, |
| 216 | + ], |
| 217 | + sidebar: { |
| 218 | + "/_blog/": blogSidebar, |
| 219 | + "/blog/": blogSidebar, |
| 220 | + "/": docsSidebar, |
| 221 | + }, |
| 222 | + footer: { |
| 223 | + links: [ |
| 224 | + { |
| 225 | + title: "Docs", |
| 226 | + children: [ |
| 227 | + { |
| 228 | + text: "Introduction", |
| 229 | + link: "/introduction/", |
| 230 | + }, |
| 231 | + { |
| 232 | + text: "Building a node with LDK", |
| 233 | + link: "/building-a-node-with-ldk/introduction", |
| 234 | + }, |
| 235 | + { |
| 236 | + text: "Running a sample LDK node", |
| 237 | + link: "/running-a-sample-ldk-node/", |
| 238 | + }, |
| 239 | + { |
| 240 | + text: "Architecture", |
| 241 | + link: "/introduction/architecture/", |
| 242 | + }, |
| 243 | + { |
| 244 | + text: "Blockchain Data", |
| 245 | + link: "/blockchain_data/introduction/", |
| 246 | + }, |
| 247 | + { |
| 248 | + text: "Key Management", |
| 249 | + link: "/key_management/", |
| 250 | + }, |
| 251 | + { |
| 252 | + text: "Examples", |
| 253 | + link: "/examples/", |
| 254 | + }, |
| 255 | + ], |
| 256 | + }, |
| 257 | + { |
| 258 | + title: "Community", |
| 259 | + children: [ |
| 260 | + { |
| 261 | + text: "GitHub", |
| 262 | + link: githubUrl, |
| 263 | + rel: "noopener noreferrer", |
| 264 | + }, |
| 265 | + { |
| 266 | + text: "Twitter", |
| 267 | + link: "https://twitter.com/lightningdevkit", |
| 268 | + rel: "noopener noreferrer", |
| 269 | + }, |
| 270 | + { |
| 271 | + text: "Chat on Discord", |
| 272 | + link: discordUrl, |
| 273 | + rel: "noopener noreferrer", |
| 274 | + }, |
| 275 | + { |
| 276 | + text: "LDK Calendar", |
| 277 | + link: "https://calendar.google.com/calendar/embed?src=c_e6fv6vlshbpoob2mmbvblkkoj4%40group.calendar.google.com", |
| 278 | + rel: "noopener noreferrer", |
| 279 | + }, |
| 280 | + { |
| 281 | + text: "LDK Review Club", |
| 282 | + link: "http://ldk.reviews/", |
| 283 | + rel: "noopener noreferrer", |
| 284 | + }, |
| 285 | + { |
| 286 | + text: "Code of Conduct", |
| 287 | + link: "/code_of_conduct", |
| 288 | + rel: "noopener noreferrer", |
| 289 | + }, |
| 290 | + ], |
| 291 | + }, |
| 292 | + { |
| 293 | + title: "Resources", |
| 294 | + children: [ |
| 295 | + { |
| 296 | + text: "Case Studies", |
| 297 | + link: "/case-studies/", |
| 298 | + }, |
| 299 | + { |
| 300 | + text: "Blog", |
| 301 | + link: "/blog/", |
| 302 | + }, |
| 303 | + ], |
| 304 | + }, |
| 305 | + { |
| 306 | + title: "Other", |
| 307 | + children: [ |
| 308 | + { |
| 309 | + text: "Bitcoin Dev Kit", |
| 310 | + link: "https://bitcoindevkit.org/", |
| 311 | + rel: "noopener noreferrer", |
| 312 | + }, |
| 313 | + { |
| 314 | + text: "Reporting a Vulnerability", |
| 315 | + rel: "noopener noreferrer", |
| 316 | + }, |
| 317 | + ], |
| 318 | + }, |
| 319 | + ], |
| 320 | + copyright: "Copyright © 2024 LDK Developers", |
| 321 | + }, |
| 322 | + }, |
| 323 | +}; |
0 commit comments